00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024 #import <Foundation/Foundation.h>
00025
00026 #import "BCVideo.h"
00027 #import "BCRendition.h"
00028 #import "BCPlaylist.h"
00029 #import "BCImage.h"
00030 #import "BCCuePoint.h"
00031 #import "BCItemCollection.h"
00032
00095 @interface BCMediaAPI : NSObject
00096 {
00097 NSString *readToken;
00098 BCMediaDeliveryType mediaDeliveryType;
00099 }
00100
00107 @property (nonatomic, retain) NSString *readToken;
00108
00116 @property (nonatomic, assign) BCMediaDeliveryType mediaDeliveryType;
00117
00125 - (id) initWithReadToken:(NSString *) rt;
00126
00135 - (NSString *) getErrorsAsString:(NSError *) error;
00136
00137 #pragma mark Video Read APIs
00138
00140 - (BCItemCollection *) findAllVideos:(NSError **) error;
00141
00143 - (BCItemCollection *) findAllVideos:(int) pageSize pageNumber:(int)pageNumber sortBy:(BCSortByType)sortByType
00144 sortOrder:(BCSortOrderType)sortOrderType getItemCount:(BOOL)getItemCount
00145 videoFields:(NSArray *)videoFields customFields:(NSArray *)customFields
00146 error:(NSError **) error;
00147
00149 - (BCVideo *) findVideoById:(long long) videoId error:(NSError **) error;
00150
00152 - (BCVideo *) findVideoById:(long long) videoId videoFields:(NSArray *)videoFields
00153 customFields:(NSArray *)customFields error:(NSError **) error;
00154
00156 - (BCItemCollection *) findRelatedVideos:(long long) videoId error:(NSError **) error;
00157
00159 - (BCItemCollection *) findRelatedVideos:(long long) videoId referenceId:(NSString *) referenceId
00160 pageSize:(int) pageSize pageNumber:(int) pageNumber getItemCount:(BOOL) getItemCount
00161 videoFields:(NSArray *)videoFields customFields:(NSArray *)customFields
00162 error:(NSError **) error;
00163
00165 - (BCItemCollection *) findVideosByIds:(NSArray *) videoIds error:(NSError **) error;
00166
00168 - (BCItemCollection *) findVideosByIds:(NSArray *) videoIds videoFields:(NSArray *) videoFields
00169 customFields:(NSArray *)customFields error:(NSError **) error;
00170
00172 - (BCVideo *) findVideoByReferenceId:(NSString *) referenceId error:(NSError **) error;
00173
00175 - (BCVideo *) findVideoByReferenceId:(NSString *) referenceId videoFields:(NSArray *) videoFields
00176 customFields:(NSArray *)customFields error:(NSError **) error;
00177
00179 - (BCItemCollection *) findVideosByReferenceIds:(NSArray *) referenceIds error:(NSError **) error;
00180
00182 - (BCItemCollection *) findVideosByReferenceIds:(NSArray *) referenceIds videoFields:(NSArray *) videoFields
00183 customFields:(NSArray *)customFields error:(NSError **) error;
00184
00186 - (BCItemCollection *) findVideosByUserId:(NSString *) userId error:(NSError **) error;
00187
00189 - (BCItemCollection *) findVideosByUserId:(NSString *) userId pageSize:(int)pageSize pageNumber:(int)pageNumber
00190 sortBy:(BCSortByType)sortByType sortOrder:(BCSortOrderType)sortOrderType getItemCount:(BOOL)getItemCount
00191 videoFields:(NSArray *)videoFields customFields:(NSArray *)customFields error:(NSError **) error;
00192
00194 - (BCItemCollection *) findModifiedVideos:(NSDate *) fromDate error:(NSError **) error;
00195
00197 - (BCItemCollection *) findModifiedVideos:(NSDate *) fromDate filters:(NSArray *) filters pageSize:(int)pageSize pageNumber:(int)pageNumber
00198 sortBy:(BCSortByType)sortByType sortOrder:(BCSortOrderType)sortOrderType getItemCount:(BOOL)getItemCount
00199 videoFields:(NSArray *)videoFields customFields:(NSArray *)customFields error:(NSError **) error;
00200
00202 - (BCItemCollection *) findVideosByText:(NSString *) text error:(NSError **) error;
00203
00205 - (BCItemCollection *) findVideosByText:(NSString *) text pageSize:(int)pageSize pageNumber:(int)pageNumber getItemCount:(BOOL)getItemCount
00206 videoFields:(NSArray *)videoFields customFields:(NSArray *)customFields error:(NSError **) error;
00207
00209 - (BCItemCollection *) findVideosByTags:(NSArray *) andTags orTags:(NSArray *)orTags error:(NSError **) error;
00210
00212 - (BCItemCollection *) findVideosByTags:(NSArray *) andTags orTags:(NSArray *)orTags pageSize:(int)pageSize pageNumber:(int)pageNumber
00213 sortBy:(BCSortByType)sortByType sortOrder:(BCSortOrderType)sortOrderType getItemCount:(BOOL)getItemCount
00214 videoFields:(NSArray *)videoFields customFields:(NSArray *)customFields error:(NSError **) error;
00215
00216 #pragma mark Playlist Read APIs
00217
00222
00223 - (BCItemCollection *) findAllPlaylists:(NSError **) error;
00224
00226 - (BCItemCollection *) findAllPlaylists:(int) pageSize pageNumber:(int)pageNumber sortBy:(BCSortByType)sortByType
00227 sortOrder:(BCSortOrderType)sortOrderType getItemCount:(BOOL)getItemCount
00228 videoFields:(NSArray *)videoFields playlistFields:(NSArray *)playlistFields
00229 customFields:(NSArray *) customFields error:(NSError **) error;
00230
00232 - (BCPlaylist *) findPlaylistById:(long long)playlistId error:(NSError **) error;
00233
00235 - (BCPlaylist *) findPlaylistById:(long long)playlistId videoFields:(NSArray *)videoFields
00236 playlistFields:(NSArray *)playlistFields customFields:(NSArray *) customFields
00237 error:(NSError **) error;
00238
00240 - (BCItemCollection *) findPlaylistsByIds:(NSArray *) playlistIds error:(NSError **) error;
00241
00243 - (BCItemCollection *) findPlaylistsByIds:(NSArray *) playlistIds videoFields:(NSArray *)videoFields
00244 playlistFields:(NSArray *)playlistFields customFields:(NSArray *) customFields
00245 error:(NSError **) error;
00246
00248 - (BCPlaylist *) findPlaylistByReferenceId:(NSString *) referenceId error:(NSError **) error;
00249
00251 - (BCPlaylist *) findPlaylistByReferenceId:(NSString *) referenceId videoFields:(NSArray *)videoFields
00252 playlistFields:(NSArray *)playlistFields customFields:(NSArray *) customFields
00253 error:(NSError **) error;
00254
00256 - (BCItemCollection *) findPlaylistsByReferenceIds:(NSArray *) referenceIds error:(NSError **) error;
00257
00259 - (BCItemCollection *) findPlaylistsByReferenceIds:(NSArray *) referenceIds videoFields:(NSArray *)videoFields
00260 playlistFields:(NSArray *)playlistFields customFields:(NSArray *) customFields
00261 error:(NSError **) error;
00262
00264 - (BCItemCollection *) findPlaylistsForPlayerId:(long long) playerId error:(NSError **) error;
00265
00267 - (BCItemCollection *) findPlaylistsForPlayerId:(long long) playerId pageSize:(int) pageSize pageNumber:(int)pageNumber
00268 getItemCount:(BOOL)getItemCount videoFields:(NSArray *)videoFields playlistFields:(NSArray *)playlistFields
00269 customFields:(NSArray *) customFields error:(NSError **) error;
00270
00271 @end
00272