/// <summary>
/// Find all playlists in this account.
/// </summary>
/// <param name="howMany">
/// Number of videos returned (-1 will return all) defaults to -1
/// </param>
/// <param name="sortBy">
/// The field by which to sort (defaults to CREATION_DATE)
/// </param>
/// <param name="sortOrder">
/// The direction by which to sort (default to DESC)
/// </param>
/// <param name="video_fields">
/// A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <param name="custom_fields">
/// A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <param name="playlist_fields">
/// A comma-separated list of the fields you wish to have populated in the playlists contained in the returned object. Passing null populates with all fields.
/// </param>
/// <returns>
/// Returns a BCQueryResult item
/// </returns>
public BCQueryResult FindAllPlaylists(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List <VideoFields> video_fields, List <String> custom_fields, List <string> playlist_fields, MediaDeliveryTypeEnum media_delivery)
{
Dictionary <String, String> reqparams = new Dictionary <string, string>();
//Build the REST parameter list
reqparams.Add("command", "find_all_playlists");
reqparams.Add("sort_order", sortOrder.ToString());
reqparams.Add("sort_by", sortBy.ToString());
reqparams.Add("media_delivery", media_delivery.ToString());
if (howMany >= 0)
{
reqparams.Add("page_size", howMany.ToString());
}
if (playlist_fields != null)
{
reqparams.Add("playlist_fields", Implode(playlist_fields));
}
if (video_fields != null)
{
reqparams.Add("video_fields", video_fields.ToFieldString());
}
if (custom_fields != null)
{
reqparams.Add("custom_fields", Implode(custom_fields));
}
BCQueryResult qr = MultipleQueryHandler(reqparams, BCObjectType.playlists, Account);
return(qr);
}
public override BCResult FindAllVideos(int pageSize, int pageNumber, BCSortByType sortBy, BCSortOrderType sortOrder)
{
return CacheHelperFactory.Get(CacheHelperType.Empty).GetFromCache<BCResult>(String.Format("FindAllVideos_{0}{1}", pageSize, pageNumber), cacheTimeoutInMinutes, () =>
{
BCResult result;
try
{
if (_enableBrightcoveAPI == false)
throw new EmptyResultException(new BCResult(0, new List<BCVideo>()), emptyCacheTimeoutInMinutes);
result = base.FindAllVideos(pageSize, pageNumber, sortBy, sortOrder);
}
catch (Exception ex)
{
// Log the exception
_log.Error("Brightcove API call failed.", ex);
throw new EmptyResultException(new BCResult(0, new List<BCVideo>()), emptyCacheTimeoutInMinutes);
}
if (result.totalCount == 0)
throw new EmptyResultException(new BCResult(0, new List<BCVideo>()), emptyCacheTimeoutInMinutes);
return result;
});
}
/// <summary>
/// Find all playlists in this account.
/// </summary>
/// <param name="howMany">
/// Number of videos returned (-1 will return all) defaults to -1
/// </param>
/// <param name="sortBy">
/// The field by which to sort (defaults to CREATION_DATE)
/// </param>
/// <param name="sortOrder">
/// The direction by which to sort (default to DESC)
/// </param>
/// <param name="video_fields">
/// A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <param name="custom_fields">
/// A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <param name="playlist_fields">
/// A comma-separated list of the fields you wish to have populated in the playlists contained in the returned object. Passing null populates with all fields.
/// </param>
/// <returns>
/// Returns a BCQueryResult item
/// </returns>
public BCQueryResult FindAllPlaylists(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<String> custom_fields, List<string> playlist_fields, MediaDeliveryTypeEnum media_delivery) {
Dictionary<String, String> reqparams = new Dictionary<string, string>();
//Build the REST parameter list
reqparams.Add("command", "find_all_playlists");
reqparams.Add("sort_order", sortOrder.ToString());
reqparams.Add("sort_by", sortBy.ToString());
reqparams.Add("media_delivery", media_delivery.ToString());
if (howMany >= 0) reqparams.Add("page_size", howMany.ToString());
if (playlist_fields != null) reqparams.Add("playlist_fields", Implode(playlist_fields));
if (video_fields != null) reqparams.Add("video_fields", video_fields.ToFieldString());
if (custom_fields != null) reqparams.Add("custom_fields", Implode(custom_fields));
BCQueryResult qr = MultipleQueryHandler(reqparams, BCObjectType.playlists, Account);
return qr;
}
public BCQueryResult FindVideosByTags(List<String> and_tags, List<String> or_tags, int pageSize, int pageNumber, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<String> custom_fields) {
return FindVideosByTags(and_tags, or_tags, pageSize, pageNumber, sortBy, sortOrder, video_fields, custom_fields, MediaDeliveryTypeEnum.DEFAULT);
}
public BCQueryResult FindAllVideos(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<string> custom_fields, MediaDeliveryTypeEnum media_delivery, int pageNumber, bool getItemCount)
{
Dictionary<String, String> reqparams = new Dictionary<string, string>();
//Build the REST parameter list
reqparams.Add("command", "find_all_videos");
if (video_fields != null) reqparams.Add("video_fields", video_fields.ToFieldString());
if (custom_fields != null) reqparams.Add("custom_fields", Implode(custom_fields));
reqparams.Add("sort_order", sortOrder.ToString());
reqparams.Add("sort_by", sortBy.ToString());
reqparams.Add("media_delivery", media_delivery.ToString());
if (howMany >= 0) reqparams.Add("page_size", howMany.ToString());
if (pageNumber > 0) reqparams.Add("page_number", pageNumber.ToString());
if (getItemCount) reqparams.Add("get_item_count", "true");
return MultipleQueryHandler(reqparams, BCObjectType.videos, Account);
}
public BCQueryResult FindVideosByText(string text, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields) {
return FindVideosByText(text, howMany, sortBy, sortOrder, video_fields, null);
}
public BCQueryResult FindVideosByTags(List<String> and_tags, List<String> or_tags, BCSortByType sortBy, BCSortOrderType sortOrder) {
return FindVideosByTags(and_tags, or_tags, -1, sortBy, sortOrder);
}
public BCQueryResult FindModifiedVideos(DateTime from_date, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<string> custom_fields, List<string> filter) {
return FindModifiedVideos(from_date, howMany, sortBy, sortOrder, video_fields, custom_fields, filter, MediaDeliveryTypeEnum.DEFAULT);
}
public BCQueryResult FindVideosByText(string text, BCSortByType sortBy) {
return FindVideosByText(text, -1, sortBy, BCSortOrderType.ASC, null, null);
}
/// <summary>
/// Gets all the videos associated with the given campaign id
/// </summary>
/// <param name="campaignId">
/// The id of the campaign you'd like to fetch videos for.
/// </param>
/// <param name="howMany">
/// Number of videos returned (-1 will return all) defaults to -1
/// </param>
/// <param name="sortBy">
/// The field by which to sort (defaults to CREATION_DATE)
/// </param>
/// <param name="sortOrder">
/// The direction by which to sort (default to DESC)
/// </param>
/// <param name="video_fields">
/// A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <param name="custom_fields">
/// A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <returns>
/// Returns a BCQueryResult item
/// </returns>
public BCQueryResult FindVideosByCampaignId(long campaignId, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<string> custom_fields, MediaDeliveryTypeEnum media_delivery) {
Dictionary<String, String> reqparams = new Dictionary<string, string>();
//Build the REST parameter list
reqparams.Add("command", "find_videos_by_campaign_id");
reqparams.Add("campaign_id", campaignId.ToString());
reqparams.Add("media_delivery", media_delivery.ToString());
if (video_fields != null) reqparams.Add("video_fields", video_fields.ToFieldString());
if (custom_fields != null) reqparams.Add("custom_fields", Implode(custom_fields));
reqparams.Add("sort_order", sortOrder.ToString());
reqparams.Add("sort_by", sortBy.ToString());
if (howMany >= 0) reqparams.Add("page_size", howMany.ToString());
return MultipleQueryHandler(reqparams, BCObjectType.videos, Account);
}
public BCQueryResult FindModifiedVideos(DateTime from_date, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder) {
return FindModifiedVideos(from_date, howMany, sortBy, sortOrder, null);
}
/// <summary>
/// This will return a generic search for videos
/// </summary>
/// <param name="howMany">
/// The number of videos to return (-1 will return all) defaults to -1
/// </param>
/// <param name="sortBy">
/// The field by which to sort (defaults to CREATION_DATE)
/// </param>
/// <param name="sortOrder">
/// The direction by which to sort (default to DESC)
/// </param>
/// <param name="video_fields">
/// A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <param name="custom_fields">
/// A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <returns>
/// Returns a BCQueryResult item
/// </returns>
public BCQueryResult FindAllVideos(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<string> custom_fields, MediaDeliveryTypeEnum media_delivery)
{
return FindAllVideos(howMany, sortBy, sortOrder, video_fields, custom_fields, media_delivery, 0, false);
}
public BCQueryResult FindVideosByCampaignId(long campaignId, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields) {
return FindVideosByCampaignId(campaignId, howMany, sortBy, sortOrder, video_fields, null);
}
public BCQueryResult FindAllPlaylists(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<String> custom_fields, List<string> playlist_fields) {
return FindAllPlaylists(howMany, sortBy, sortOrder, video_fields, custom_fields, playlist_fields, MediaDeliveryTypeEnum.DEFAULT);
}
public BCQueryResult FindAllPlaylists(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<String> custom_fields) {
return FindAllPlaylists(howMany, sortBy, sortOrder, video_fields, custom_fields, null);
}
public BCQueryResult FindAllPlaylists(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder)
{
return(FindAllPlaylists(howMany, sortBy, sortOrder, null));
}
public BCQueryResult FindAllPlaylists(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List <VideoFields> video_fields, List <String> custom_fields, List <string> playlist_fields)
{
return(FindAllPlaylists(howMany, sortBy, sortOrder, video_fields, custom_fields, playlist_fields, MediaDeliveryTypeEnum.DEFAULT));
}
public BCQueryResult FindAllPlaylists(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List <VideoFields> video_fields, List <String> custom_fields)
{
return(FindAllPlaylists(howMany, sortBy, sortOrder, video_fields, custom_fields, null));
}
public BCQueryResult FindVideosByCampaignId(long campaignId, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<string> custom_fields) {
return FindVideosByCampaignId(campaignId, howMany, sortBy, sortOrder, video_fields, custom_fields, MediaDeliveryTypeEnum.DEFAULT);
}
/// <summary>
/// Searches through all the videos in this account, and returns a collection of videos whose name, short description, or long description contain a match for the specified text.
/// </summary>
/// <param name="text">
/// The text we're searching for.
/// </param>
/// <param name="howMany">
/// Number of videos returned (-1 will return all) defaults to -1
/// </param>
/// <param name="sortBy">
/// The field by which to sort (defaults to CREATION_DATE)
/// </param>
/// <param name="sortOrder">
/// The direction by which to sort (default to DESC)
/// </param>
/// <param name="video_fields">
/// A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <param name="custom_fields">
/// A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <returns>
/// Returns a BCQueryResult item
/// </returns>
public BCQueryResult FindVideosByText(string text, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<string> custom_fields, MediaDeliveryTypeEnum media_delivery, int pageNumber, bool getItemCount)
{
Dictionary<String, String> reqparams = new Dictionary<string, string>();
string encText = HttpUtility.UrlEncode(text);
string customFieldList = string.Empty;
//Build the REST parameter list
reqparams.Add("command", "search_videos");
if (custom_fields != null)
{
foreach (string field in custom_fields)
{
customFieldList += "&any=" + field + ":" + encText;
}
}
// HACK HACK - the API has changed at Brightcove - now takes multiple "any" params, but this SDK does not allow duplicate keys
reqparams.Add("any=" + encText + customFieldList + "&any", "tag:" + text);
reqparams.Add("media_delivery", media_delivery.ToString());
if (video_fields != null) reqparams.Add("video_fields", video_fields.ToFieldString());
if (custom_fields != null) reqparams.Add("custom_fields", Implode(custom_fields));
reqparams.Add("sort_order", sortOrder.ToString());
if (howMany >= 0) reqparams.Add("page_size", howMany.ToString());
if (pageNumber > 0) reqparams.Add("page_number", pageNumber.ToString());
if (getItemCount) reqparams.Add("get_item_number", "true");
return MultipleQueryHandler(reqparams, BCObjectType.videos, Account);
}
public BCQueryResult FindModifiedVideos(DateTime from_date, BCSortByType sortBy) {
return FindModifiedVideos(from_date, -1, sortBy, BCSortOrderType.ASC);
}
public BCQueryResult FindAllVideos(BCSortByType sortBy, BCSortOrderType sortOrder) {
return FindAllVideos(-1, sortBy, sortOrder);
}
public BCQueryResult FindModifiedVideos(DateTime from_date, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<string> custom_fields) {
return FindModifiedVideos(from_date, howMany, sortBy, sortOrder, video_fields, custom_fields, null);
}
public BCQueryResult FindAllVideos(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder) {
return FindAllVideos(howMany, sortBy, sortOrder, null);
}
/// <summary>
/// This will find all modified videos
/// </summary>
/// <param name="from_date">The date, specified in minutes since January 1st, 1970 00:00:00 GMT, of the oldest Video which you would like returned.</param>
/// <param name="howMany">Number of items returned per page. A page is a subset of all of the items that satisfy the request. The maximum page size is 25; if you do not set this argument, or if you set it to an integer > 25, your results will come back as if you had set page_size=25.</param>
/// <param name="sortBy">The field by which to sort the results. A SortByType: One of PUBLISH_DATE, CREATION_DATE, MODIFIED_DATE, PLAYS_TOTAL, PLAYS_TRAILING_WEEK.</param>
/// <param name="sortOrder">How to order the results: ascending (ASC) or descending (DESC).</param>
/// <param name="video_fields">A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, the method returns the following fields of the video: id, name, shortDescription, longDescription, creationDate, publisheddate, lastModifiedDate, linkURL, linkText, tags, videoStillURL, thumbnailURL, referenceId, length, economics, playsTotal, playsTrailingWeek. If you use a token with URL access, this method also returns FLVURL, renditions, FLVFullLength, videoFullLength.</param>
/// <param name="custom_fields">A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. If you omit this parameter, no custom fields are returned, unless you include the value 'customFields' in the video_fields parameter.</param>
/// <param name="filter">A comma-separated list of filters, specifying which categories of videos you would like returned. Valid filter values are PLAYABLE, UNSCHEDULED, INACTIVE, and DELETED.</param>
/// <param name="media_delivery">If universal delivery service is enabled for your account, set this optional parameter to http to return video by HTTP, rather than streaming. Meaningful only if used together with the video_fields=FLVURL, videoFullLength, or renditions parameters. This is a MediaDeliveryTypeEnum with a value of http or default.</param>
/// <returns>Returns a BCQueryResult Item</returns>
public BCQueryResult FindModifiedVideos(DateTime from_date, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<string> custom_fields, List<string> filter, MediaDeliveryTypeEnum media_delivery) {
Dictionary<String, String> reqparams = new Dictionary<string, string>();
//Build the REST parameter list
reqparams.Add("command", "find_modified_videos");
if (from_date != null) reqparams.Add("from_date", from_date.ToUnixTime());
if (video_fields != null) reqparams.Add("video_fields", video_fields.ToFieldString());
if (custom_fields != null) reqparams.Add("custom_fields", Implode(custom_fields));
if (filter != null) reqparams.Add("filter", Implode(filter));
reqparams.Add("sort_order", sortOrder.ToString());
reqparams.Add("sort_by", sortBy.ToString());
reqparams.Add("media_delivery", media_delivery.ToString());
if (howMany >= 0) reqparams.Add("page_size", howMany.ToString());
return MultipleQueryHandler(reqparams, BCObjectType.videos, Account);
}
public BCQueryResult FindAllVideos(int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields) {
return FindAllVideos(howMany, sortBy, sortOrder, video_fields, null);
}
public BCQueryResult FindVideosByText(string text, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder) {
return FindVideosByText(text, howMany, sortBy, sortOrder, null, null);
}
public BCQueryResult FindVideosByUserId(long userId, BCSortByType sortBy) {
return FindVideosByUserId(userId, -1, sortBy, BCSortOrderType.ASC, null, null);
}
public BCQueryResult FindVideosByText(string text, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<string> custom_fields) {
return FindVideosByText(text, howMany, sortBy, sortOrder, video_fields, custom_fields, MediaDeliveryTypeEnum.DEFAULT);
}
public BCQueryResult FindVideosByUserId(long userId, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder) {
return FindVideosByUserId(userId, howMany, sortBy, sortOrder, null, null);
}
public BCQueryResult FindVideosByTags(List<String> and_tags, List<String> or_tags, int pageSize, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields) {
return FindVideosByTags(and_tags, or_tags, pageSize, sortBy, sortOrder, video_fields, null);
}
public BCQueryResult FindVideosByCampaignId(long campaignId, BCSortByType sortBy) {
return FindVideosByCampaignId(campaignId, -1, sortBy, BCSortOrderType.ASC, null, null);
}
/// <summary>
/// Performs a search on all the tags of the videos in this account, and returns a collection of videos that contain the specified tags. Note that tags are not case-sensitive.
/// </summary>
/// <param name="and_tags">
/// Limit the results to those that contain all of these tags.
/// </param>
/// <param name="or_tags">
/// Limit the results to those that contain at least one of these tags.
/// </param>
/// <param name="pageSize">
/// Number of videos returned (-1 will return all) defaults to -1 max is 100
/// </param>
/// <param name="pageNumber">
/// The number of page to return. Default is 0 (First page)
/// </param>
/// <param name="sortBy">
/// The field by which to sort (defaults to CREATION_DATE)
/// </param>
/// <param name="sortOrder">
/// The direction by which to sort (default to DESC)
/// </param>
/// <param name="video_fields">
/// A comma-separated list of the fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <param name="custom_fields">
/// A comma-separated list of the custom fields you wish to have populated in the videos contained in the returned object. Passing null populates with all fields. (defaults to all)
/// </param>
/// <returns>
/// Returns a BCQueryResult item
/// </returns>
public BCQueryResult FindVideosByTags(List<String> and_tags, List<String> or_tags, int pageSize, int pageNumber, BCSortByType sortBy, BCSortOrderType sortOrder, List<VideoFields> video_fields, List<String> custom_fields, MediaDeliveryTypeEnum media_delivery) {
Dictionary<String, String> reqparams = new Dictionary<string, string>();
//Build the REST parameter list
reqparams.Add("command", "find_videos_by_tags");
if (and_tags != null) reqparams.Add("and_tags", Implode(and_tags));
if (or_tags != null) reqparams.Add("or_tags", Implode(or_tags));
if (video_fields != null) reqparams.Add("video_fields", video_fields.ToFieldString());
if (custom_fields != null) reqparams.Add("custom_fields", Implode(custom_fields));
reqparams.Add("sort_order", sortOrder.ToString());
reqparams.Add("sort_by", sortBy.ToString());
reqparams.Add("media_delivery", media_delivery.ToString());
if (pageSize >= 0) reqparams.Add("page_size", pageSize.ToString());
if (pageNumber >= 0) reqparams.Add("page_number", pageNumber.ToString());
return MultipleQueryHandler(reqparams, BCObjectType.videos, Account);
}
public BCQueryResult FindVideosByCampaignId(long campaignId, int howMany, BCSortByType sortBy, BCSortOrderType sortOrder) {
return FindVideosByCampaignId(campaignId, howMany, sortBy, sortOrder, null, null);
}
