ActsAsKaltura
Kaltura is SaaS based video streaming platform, officially kaltura ruby API is available here. Another fork could be found here. Based on velir kaltura ruby library, we somewhere in... ruby devs have built this gem to simplify kaltura video and cuepoint synchronization process.
acts_as_kaltura_video
It sync your video model with kaltura MediaEntry.
Usages -
class Video
acts_as_kaltura_video :delegate => [:thumbnail_url, :duration],
# If you don't mention :setting_scope it will take
# configuration from config/kaltura.yml
:setting_scope => lambda { |v|
#... provide configuration hash
}
# Set media entry object based on your required fields
def as_kaltura_entry
Kaltura::MediaEntry.new.tap do |entry|
entry.name = title
entry.description = description
entry.tags = tags.map &:name
entry.media_type = Kaltura::Constants::Media::Type::VIDEO
end
end
endVideo model must includes the following fields -
- kaltura_key (string)
- kaltura_syncd_at (datetime)
if you use :delegate => [kaltura web service fields] you have to add fields for each delegatable field.
ie. for :delegate => [:thumbnail_url] you have to add :thumbnail_url (text) to video model.
Create video
Video.create(:title => 'My birthday video', :description => 'Great family moments', :video_file => ..)Using delegate methods
Video.first.thumbnail_url it will check local thumbnail_url attribute if not found it will retrieve thumbnail through kaltura web service and it will run update_column :thumbnail_url, value.
acts_as_kaltura_annotation
It will sync your Annotation model with kaltura cuepoint annotation object.
Usages -
class Annotation < ActiveRecord::Base
belongs_to :video
acts_as_kaltura_annotation
def as_annotation_cuepoint
ActsAsKaltura::Extension::KalturaAnnotation.new.tap do |cp|
cp.cue_point_type = ActsAsKaltura::Extension::KalturaAnnotation::TYPE_ANNOTATION
# convert to milliseconds
cp.start_time = self.start_time.to_i * 1000
cp.end_time = self.end_time.to_i * 1000
cp.system_name = self.title
cp.text = self.description
cp.entry_id = self.video.kaltura_key
end
end
endAnnotation model must includes the following fields -
- cuepoint_key (String)
acts_as_kaltura_category
Sync local categories with Kaltura. You have to set existing kaltura category id to any of your parent categories. When you create sub category (you must have parent method exposed) it will automatically pushed to kaltura. Same goes for updating and deleting kaltura category. (if you destroy child category it will automatically remove kaltura category)
Usages -
class Category < ActiveRecord::Base
belongs_to :parent, :class_name => 'Category'
has_many :categories, :foreign_key => 'parent_id'
has_and_belongs_to_many :videos
acts_as_kaltura_category
def as_kaltura_category
Kaltura::Category.new.tap do |c|
c.name = self.name
if kaltura_reference_found?
c.parent_id = self.parent.kaltura_category_key
end
end
end
endRequired fields
- kaltura_category_key (String)
How to install
gem install acts_as_kaltura
Configuration
Create file under RAILS_ROOT/config/kaltura.yml.
Checkout the sample
Changes
-
Added kaltura_parent_categories class method
-
Made kaltura_reference_found? method public