Use this gem to interact with the SproutVideo API
First, you'll need to install the gem
gem install sproutvideo-rb
The first thing you'll need to interact with the SproutVideo API is your API key. You can use your API key in one of two ways. The first and easiest is to set it and forget it on the Sproutvideo module like so:
Sproutvideo.api_key = 'abcd1234'Alternatively, you can use an environment variable:
ENV['SPROUTVIDEO_API_KEY'] = 'abcd1234'The following methods are available: list, create, details, update, upload_poster_frame,destroy.
By default the videos listing is paginated with 25 videos per page and sorted by upload date in ascending order.
You can pass two parameters to control the paging: page and per_page.
Sproutvideo::Video.list
Sproutvideo::Video.list(:per_page => 10)
Sproutvideo::Video.list(:per_page => 10, :page => 2)You can control sorting order by order_by and order_dir parameter.
Sproutvideo::Video.list(:order_by => "created_at")
Sproutvideo::Video.list(:order_by => "updated_at")
Sproutvideo::Video.list(:order_by => "title", :order_dir => "asc")
Sproutvideo::Video.list(:order_by => "duration", :order_dir => "desc")You can also pass tag_id, tag_name, privacy and state parameters to restrict result.
Sproutvideo::Video.list(:tag_id => 'a323d32')
Sproutvideo::Video.list(:tag_name => 'funny cat videos')
Sproutvideo::Video.list(:privacy => 2)
Sproutvideo::Video.list(:state => "processing")Values of privacy is listed at Video Privacy section.
Values of state is listed at Video States section.
The string passed to details is the ID of a SproutVideo video.
Sproutvideo::Video.details('abc123')The most basic upload you can perform is to just pass the path to the video file to the method. The title of the video will default to the name of the file.
Sproutvideo::Video.create('/path/to/video.mp4')You can set the title as well as many other parameters by passing them as a hash
Sproutvideo::Video.create('/path/to/video.mp4',
:title => 'My Awesome Video',
:description => 'This video is great',
:privacy => 2)You can also apply any number of tags to the new upload by passing their ids along:
Sproutvideo::Video.create('/path/to/video.mp4',
:tags => ['ec61', 'abc123'])You can also create or add tags on the fly by passing in tag names:
Sproutvideo::Video.create('/path/to/video.mp4',
:tag_names => ['Tag One', 'Tag Two'])You can also specify a webhook url. We'll send an HTTP POST with the video json when the video has finished processing or if there was an error during processing:
Sproutvideo::Video.create('/path/to/video.mp4',
:notification_url => 'http://example.com/webhook_url')The first parameter is the id of the video you wish to edit. The second parameter is a hash of attributes to update on the video.
Sproutvideo::Video.update('abc123', :title => 'Updated Title')The first parameter is the id of the video you wish to replace. The second parameter is the local path to the video file.
Sproutvideo::Video.replace('abc123', '/path/to/video.mp4')To add a tag to a video, make sure to include all of the tags currently associated with the video. For instance if the video already has tags with the ids "abc" and "123" and you want to add a tag with the id "def" do pass "abc", "123" and "def" to the update method.
Sproutvideo::Video.update('abc123',
:tags => ["abc", "123", "def"])If you want to remove a tag from a video, remove the tag from the list of tags on the video but make sure to include all of the tags you wish to keep. For instance, if you now want to remove the tag with id "123" from the example above, pass in "abc" and "def"
Sproutvideo::Video.update("abc123",
:tags => ["abc","def"])You can remove all of the tags from a video by just passing an empty array as the tags parameter.
Sproutvideo::Video.update('abc123', :tags => [])You can upload a custom poster frame for a video by calling the upload_poster_frame method. The first parameter is the id of the video for wish you'd like the poster frame to be associated and the second parameter is the path to the image file.
Sproutvideo::Video.upload_poster_frame('abc123', '/path/to/image.jpg')Pass in the id of the video you wish to delete.
Sproutvideo::Video.destroy('abc123')You can use this convenience method to sign an embed code. It will return the embed code URL which can be used to build an iframe embed code.
Sproutvideo::Video.signed_embed_code(video_id, security_token, query_parameters, expiration_time, protocol)
video_id - String (Required) : The id of the video for which you're generating the signed embed code
security_token - String (Required) : The security token of the video for which you're generatingn the signed embed code
query_parameteres - Hash (Optional)
: A hash of query parameters to be passed to the embed code. Example: {'type' => 'hd', 'autoplay' => true}
expiration_time - Integer (Optional) : The number of seconds from the Epoc that this signed embed code should expire. This defaults to 5 minutes from the time the signed embed code was generated.
protocol - String (Optional)
: http or https. Defaults to http
Sproutvideo::Video.signed_embed_code('abc123','def456') #sign a base embed code with no other options
Sproutvideo::Video.signed_embed_code('abc123','def456', {'type' => 'hd'}) #set parameters for the embed code such as changing the default video type to HD
Sproutvideo::Video.signed_embed_code('abc123','def456', {}, 1368127991) #set a specific expiration time for the signed embed code. (By default the expiration time is set to 5 minutes from the time the signed embed code was generated).
Sproutvideo::Video.signed_embed_code('abc123','def456', {}, nil, 'https') #Use https instead of httpThe following methods are available: create
Sproutvideo::UploadToken.create
Sproutvideo::UploadToken.create(:return_url => 'http://example.com')
Sproutvideo::UploadToken.create(:return_url => 'http://example.com', :seconds_valid => 3600)The following methods are available: list, create, details, update, destroy.
By default the tag listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
Sproutvideo::Tag.list
Sproutvideo::Tag.list(:per_page => 10)
Sproutvideo::Tag.list(:per_page => 10, :page => 2)Sproutvideo::Tag.create(:name => 'new tag')Sproutvideo::Tag.update('abc123', :name => 'updated tag name')Pass in the id of the tag you wish to delete.
Sproutvideo::Tag.destroy('abc123')The following methods are available: list, create, details, update, destroy.
By default, the folder listing is paginated with 25 folders per page and sorted by created_at date in ascending order. You can pass tow parameters to control the paging: page and per_page. If you do not pass in a parent_id only the folders within the root folder will be returned. To get the folders in a specific folder, make sure to pass in that folder's id using the parent_id parameter.
Sproutvideo::Folder.list
Sproutvideo::Folder.last(:per_page => 10)
Sproutvideo::Folder.last(:per_page => 10, :page => 2)
Sproutvideo::Folder.last(:parent_id => 'def456')Creating a folder without a parent_id will place that folder in the root folder. Passing in a parent_id will place the newly created folder in the folder specified by parent_id.
# folder is created in the root folder.
Sproutvideo::Folder.create(:name => 'New Folder')
# folder is created as a child of the folder specified by the id 'def456'
Sproutvideo::Folder.create(:name => 'New Folder', :parent_id => 'def456')Sproutvideo::Folder.details('def456')Sproutvideo::Folder.update('def456', :name => 'New Folder Name')By default, when deleting a folder, all of the contents of that folder (videos and folders), will be moved the root folder to prevent unintended data loss. If you wish to actually delete all of the content of a folder, make sure to pass in delete_all as true.
# delete the folder and move it's contents to the root folder
Sproutvideo::Folder.destroy('def456')
# delete the folder and everything in it.
Sproutvideo::Folder.destroy('def456', :delete_all => true)The following methods are available: list, create, details, update, destroy.
By default the playlist listing is paginated with 25 playlists per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
Sproutvideo::Playlist.list
Sproutvideo::Playlist.list(:per_page => 10)
Sproutvideo::Playlist.list(:per_page => 10, :page => 2)You can add videos to a playlist when creating it by passing in the videos you'd like to add in the videos parameter in the order you'd like them to appear.
Sproutvideo::Playlist.create(
:title => 'New Playlist',
:privacy => 2,
:videos => ['abc123','def456','ghi789'])Sproutvideo::Playlist.update('abc123',
:title => 'Update Playlist Title')To add a video to a playlist, make sure to include all of the videos currently associated with that playlist. For instance if the playlist already has videos with the ids "abc" and "123" and you want to add a video with the id "def" do pass "abc", "123" and "def" to the update method.
Sproutvideo::Playlist.update('abc123',
:videos => ["abc", "123", "def"])If you want to remove a video from a playlist, remove the video from the list of videos in the playlist but make sure to include all of the videos you wish to keep. For instance, if you now want to remove the video with id "123" from the example above, pass in "abc" and "def"
Sproutvideo::Playlist.update("abc123",
:videos => ["abc","def"])You can remove all of the videos from a playlist by just passing an empty array as the videos parameter.
Sproutvideo::Playlist.update('abc123', :videos => [])Pass in the id of the playlist you wish to delete.
Sproutvideo::Playlist.destroy('abc123')The following methods are available: list, create, details, update, destroy
By default the login listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
Sproutvideo::Login.list
Sproutvideo::Login.list(:per_page => 10)
Sproutvideo::Login.list(:per_page => 10, :page => 2)Create takes two required parameters, email and password, which will be used to allow a viewer to login to watch a video if the login has an assocaited access_grant for that video.
Sproutvideo::Login.create(
:email => '[email protected]',
:password => 'thisisthepassword')The string passed to details is the ID of a SproutVideo login.
Sproutvideo::Login.details('abc123')You can change the password for a login.
Sproutvideo::Login.update('abc123',
:password => 'newpassword')Pass in the id of the login you wish to delete.
Sproutvideo::Login.destroy('asdf1234')The following methods are available: list, create, details, update, destroy
By default the access grant listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
Sproutvideo::AccessGrant.list
Sproutvideo::AccessGrant.list(:per_page => 10)
Sproutvideo::AccessGrant.list(:per_page => 10, :page => 2)Create takes two required parameters, video_id and login_id, which will be used to allow a viewer to login to watch a video based on the other optional parameters.
Sproutvideo::AccessGrant.create(
:video_id => 'abc123',
:login_id => 'abc123')bulk_create takes an array of access grant objects and creates them in a single API call to efficiently create access grants in bulk and reduce the number of API calls needed.
Sproutvideo::AccessGrant.bulk_create([
{
:video_id => 'abc123',
:login_id => 'abc123'
},{
:video_id => 'def456',
:login_id => 'def456'
}
])The string passed to details is the ID of a SproutVideo login.
Sproutvideo::AccessGrant.details('abc123')You can change the optional parameters for an access grant.
Sproutvideo::AccessGrant.update('abc123',
:allowed_plays => 20,
:access_ends_at => DateTime.parse('8/4/2014'))Pass in the id of the access grant you wish to delete.
Sproutvideo::AccessGrant.destroy('asdf1234')#Analytics The following methods are available through the API client for analytics:
- play_counts
- domains
- geo
- video_types
- playback types
- device_types
Check the API documentation for more information about the data returned by these calls.
Each method can be called on it's own for overall account data for all time like this:
Sproutvideo::Analytics.play_counts
Sproutvideo::Analytics.download_counts
Sproutvideo::Analytics.domains
Sproutvideo::Analytics.geo
Sproutvideo::Analytics.video_types
Sproutvideo::Analytics.device_typesEach method can also take an options hash containing a :video_id for retrieving overall data for a specific video:
Sproutvideo::Analytics.play_counts(:video_id => 'abc123')
Sproutvideo::Analytics.download_counts(:video_id => 'abc123')
Sproutvideo::Analytics.domains(:video_id => 'abc123')
Sproutvideo::Analytics.geo(:video_id => 'abc123')
Sproutvideo::Analytics.video_types(:video_id => 'abc123')
Sproutvideo::Analytics.device_types(:video_id => 'abc123')The following methods can also take an options hash containing a :live_stream_id for retrieving overall data for a specific live_stream:
Sproutvideo::Analytics.play_counts(:live_stream_id => 'abc123')
Sproutvideo::Analytics.domains(:live_stream_id => 'abc123')
Sproutvideo::Analytics.geo(:live_stream_id => 'abc123')
Sproutvideo::Analytics.device_types(:live_stream_id => 'abc123')Each method can also take an optional :start_date and :end_date to specify a date range for the returned data:
Sproutvideo::Analytics.play_counts(:start_date => '2013-01-01')
Sproutvideo::Analytics.device_types(:video_id => 'abc123', :end_date => '2012-12-31')The geo method can take an optional :country to retrieve playback data by city within that country
Sproutvideo::Analytics.geo(:video_id => 'abc123', :country => 'US')see api docs for more info
Sproutvideo::Analytics.popular_videos
SproutVideo::Analytics.popular_downloadsSproutvideo::Analytics.live_stream_overview('abc123')You can grab the total number of seconds of your videos that have been watched like this:
Sproutvideo::Analytics.engagementand for all livestreams:
Sproutvideo::Analytics.live_stream_engagementYou can grab engagement for a specific video like so:
Sproutvideo::Analytics.engagement(:video_id => 'abc123')or for a specific live stream:
Sproutvideo::Analytics.live_stream_engagement(:live_stream_id => 'abc123')You can grab playback sessions data for your videos with:
Sproutvideo::Analytics.engagement_sessionsand for live streams with
Sproutvideo::Analytics.live_stream_engagement_sessionsLastly, you can grab every single playback session for a video like this:
Sproutvideo::Analytics.engagement_sessions('abc123')
Sproutvideo::Analytics.engagement_sessions('abc123', page: 3)
Sproutvideo::Analytics.engagement_sessions('abc123', page: 3, :per_page => 40)and for a live stream:
Sproutvideo::Analytics.live_stream_engagement_sessions('abc123')You can also grab engagement sessions for a video for a specific email address like so:
Sproutvideo::Analytics.engagement_sessions(video_id: 'abc123', vemail: '[email protected]')The following methods are available: details, update.
To get information about your account:
Sproutvideo::Account.detailsTo update account settings:
Sproutvideo::Account.update({download_sd: true})The following methods are available: list, create, details, update, destroy. All requests for a subtitle must be given a video_id option indicating the video that you want to access or update the subtitles of.
By default the subtitle listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
Sproutvideo::Subtitle.list(:video_id => 'abc123')
Sproutvideo::Subtitle.list(:video_id => 'abc123', :per_page => 10)
Sproutvideo::Subtitle.list(:video_id => 'abc123', :per_page => 10, :page => 2)Create takes three required parameters, video_id, language, and content, which will be to add the newly created subtitle file and associate it with the provided video id.
Sproutvideo::Subtitle.create(
:video_id => 'abc123',
:language => 'en',
:content => 'WEBVTT FILE...')pass both the video and the subtitle id.
Sproutvideo::Subtitle.details(:video_id => 'abc123', id: 'fdc432')You can change the optional parameters for a subtitle.
Sproutvideo::Subtitle.create(
:video_id => 'abc123',
:language => 'de',
:id => 'fdc432')Pass in the id of the subtitle you wish to delete.
Sproutvideo::Subtitle.destroy(:video_id => 'abc123', id: 'fdc432')The following methods are available: list, create, details, update, destroy. All requests for a call to action must be given a video_id option indicating the video that you want to access or update the calls to action of.
By default the call to action listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
Sproutvideo::CallToAction.list(:video_id => 'abc123')
Sproutvideo::CallToAction.list(:video_id => 'abc123', :per_page => 10)
Sproutvideo::CallToAction.list(:video_id => 'abc123', :per_page => 10, :page => 2)Create takes five required parameters, video_id, text, url, start_time, and end_time, which will be to add the newly created subtitle file and associate it with the provided video id.
Sproutvideo::CallToAction.create(
:video_id => 'abc123',
:text => 'join now',
:start_time => 1,
:end_time => 2,
:content => 'https://sproutvideo.com')pass both the video and the call to action id.
Sproutvideo::CallToAction.details(:video_id => 'abc123', id: 'fdc432')You can change the optional parameters for a call to action.
Sproutvideo::CallToAction.create(
:video_id => 'abc123',
:text => 'get it done!',
:id => 'fdc432')Pass in the id of the call to action you wish to delete.
Sproutvideo::CallToAction.destroy(:video_id => 'abc123', id: 'fdc432')The following methods are available: list, create, details, update, destroy, and end_stream.
By default the call to action listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
Sproutvideo::LiveStream.list
Sproutvideo::LiveStream.list(:per_page => 10, :page => 2)Sproutvideo::LiveStream.create(title: 'hello')
# with a poster frame
Sproutvideo::LiveStream.create(title: 'hello', custom_poster_frame: '/path/to/posterframe.jpg')Sproutvideo::LiveStream.details('abc123')You can change the optional parameters
Sproutvideo::LiveStream.update(title: 'get it done!')
# with a poster frame
Sproutvideo::LiveStream.update(title: 'hello', custom_poster_frame: '/path/to/posterframe.jpg')Sproutvideo::LiveStream.destroy('abc123')Sproutvideo::LiveStream.end_stream('abc123')- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
- Fork the project.
- Start a feature/bugfix branch.
- Commit and push until you are happy with your contribution.
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
Copyright (c) 2021 SproutVideo. See LICENSE.txt for further details.