C# Class BrightcoveMapiWrapper.Api.BrightcoveApi

ファイルを表示 Open project: revdotcom/.NET-MAPI-Wrapper Class Usage Examples

Public Methods

Method Description
AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, FileUploadInfo fileUploadInfo, long videoId, bool resize ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, FileUploadInfo fileUploadInfo, string videoReferenceId, bool resize ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, string fileToUpload, long videoId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, string fileToUpload, long videoId, bool resize ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, string fileToUpload, string videoReferenceId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, string fileToUpload, string videoReferenceId, bool resize ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
AddLogoOverlay ( BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay logoOverlay, FileUploadInfo fileUploadInfo, long videoId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay

Adds a logo overlay image to a video.
AddLogoOverlay ( BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay logoOverlay, FileUploadInfo fileUploadInfo, string videoReferenceId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay

Adds a logo overlay image to a video.
AddLogoOverlay ( BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay logoOverlay, string fileToUpload, long videoId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay

Adds a logo overlay image to a video.
AddLogoOverlay ( BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay logoOverlay, string fileToUpload, string videoReferenceId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay

Adds a logo overlay image to a video.
CreateVideo ( BrightcoveVideo video ) : long

Creates a new video using a remote URL rendition. The remote URL should be set in the video renditions.
CreateVideo ( BrightcoveVideo video, FileUploadInfo fileUploadInfo, EncodeTo encodeTo, bool createMultipleRenditions, bool preserveSourceRendition, bool h264NoProcessing ) : long

Creates a new video by uploading a file.
CreateVideo ( BrightcoveVideo video, string fileToUpload ) : long

Creates a new video by uploading a file.
CreateVideo ( BrightcoveVideo video, string fileToUpload, EncodeTo encodeTo ) : long

Creates a new video by uploading a file.
CreateVideo ( BrightcoveVideo video, string fileToUpload, EncodeTo encodeTo, bool createMultipleRenditions ) : long

Creates a new video by uploading a file.
CreateVideo ( BrightcoveVideo video, string fileToUpload, EncodeTo encodeTo, bool createMultipleRenditions, bool preserveSourceRendition ) : long

Creates a new video by uploading a file.
CreateVideo ( BrightcoveVideo video, string fileToUpload, EncodeTo encodeTo, bool createMultipleRenditions, bool preserveSourceRendition, bool h264NoProcessing ) : long

Creates a new video by uploading a file.
DeleteVideo ( long videoId, bool cascade, bool deleteShares ) : void

Deletes a video, specified by video ID
DeleteVideo ( string referenceId, bool cascade, bool deleteShares ) : void

Deletes a video, specified by the video's reference ID
GetUploadStatus ( long videoId ) : BrightcoveUploadStatus

Determines the status of an upload.
GetUploadStatus ( string referenceId ) : BrightcoveUploadStatus

Determines the status of an upload.
RemoveLogoOverlay ( long videoId ) : void

Removes a logo overlay previously assigned to a video.
RemoveLogoOverlay ( string videoReferenceId ) : void

Removes a logo overlay previously assigned to a video.
ShareVideo ( long videoId, bool autoAccept, bool forceReshare, IEnumerable shareeAccountIds ) : ICollection

Shares the specified video with a list of sharee accounts.
UnshareVideo ( long videoId, IEnumerable shareeAccountIds ) : ICollection

Deletes the specified previously shared video from a list of sharee accounts. If a shared version of the specified video does not exist in a sharee account, no action is taken.
UpdateVideo ( BrightcoveVideo video ) : BrightcoveVideo

Updates the specified video.

Private Methods

Method Description
DoAddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, FileUploadInfo fileUploadInfo, long videoId, string videoReferenceId, bool resize ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage
DoAddLogoOverlay ( BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay logoOverlay, FileUploadInfo fileUploadInfo, long videoId, string videoReferenceId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay
DoDeleteVideo ( long videoId, string referenceId, bool cascade, bool deleteShares ) : void

Deletes a video, specified by video ID or reference ID.
DoGetUploadStatus ( long videoId, string referenceId ) : BrightcoveUploadStatus

Determines the status of an upload.
DoRemoveLogoOverlay ( long videoId, string videoReferenceId ) : void

Method Details

AddImage() public method

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
public AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, FileUploadInfo fileUploadInfo, long videoId, bool resize ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage
image BrightcoveMapiWrapper.Model.Items.BrightcoveImage The metadata for the image you'd like to create (or update).
fileUploadInfo FileUploadInfo Information for the file to be uploaded.
videoId long The ID of the video to which you'd like to assign the image.
resize bool Set this to false if you don't want your image to be automatically resized to the default size for its type. /// By default images will be resized.
return BrightcoveMapiWrapper.Model.Items.BrightcoveImage

AddImage() public method

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
public AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, FileUploadInfo fileUploadInfo, string videoReferenceId, bool resize ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage
image BrightcoveMapiWrapper.Model.Items.BrightcoveImage The metadata for the image you'd like to create (or update).
fileUploadInfo FileUploadInfo Information for the file to be uploaded.
videoReferenceId string The reference ID of the video to which you'd like to assign the image.
resize bool Set this to false if you don't want your image to be automatically resized to the default size for its type. /// By default images will be resized.
return BrightcoveMapiWrapper.Model.Items.BrightcoveImage

AddImage() public method

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
public AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, string fileToUpload, long videoId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage
image BrightcoveMapiWrapper.Model.Items.BrightcoveImage The metadata for the image you'd like to create (or update).
fileToUpload string The full path of the file to be uploaded.
videoId long The ID of the video to which you'd like to assign the image.
return BrightcoveMapiWrapper.Model.Items.BrightcoveImage

AddImage() public method

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
public AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, string fileToUpload, long videoId, bool resize ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage
image BrightcoveMapiWrapper.Model.Items.BrightcoveImage The metadata for the image you'd like to create (or update).
fileToUpload string The full path of the file to be uploaded.
videoId long The ID of the video to which you'd like to assign the image.
resize bool Set this to false if you don't want your image to be automatically resized to the default size for its type. /// By default images will be resized.
return BrightcoveMapiWrapper.Model.Items.BrightcoveImage

AddImage() public method

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
public AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, string fileToUpload, string videoReferenceId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage
image BrightcoveMapiWrapper.Model.Items.BrightcoveImage The metadata for the image you'd like to create (or update).
fileToUpload string The full path of the file to be uploaded.
videoReferenceId string The reference ID of the video to which you'd like to assign the image.
return BrightcoveMapiWrapper.Model.Items.BrightcoveImage

AddImage() public method

Add a new thumbnail or video still image to a video, or assign an existing image to another video.
public AddImage ( BrightcoveMapiWrapper.Model.Items.BrightcoveImage image, string fileToUpload, string videoReferenceId, bool resize ) : BrightcoveMapiWrapper.Model.Items.BrightcoveImage
image BrightcoveMapiWrapper.Model.Items.BrightcoveImage The metadata for the image you'd like to create (or update).
fileToUpload string The full path of the file to be uploaded.
videoReferenceId string The reference ID of the video to which you'd like to assign the image.
resize bool Set this to false if you don't want your image to be automatically resized to the default size for its type. /// By default images will be resized.
return BrightcoveMapiWrapper.Model.Items.BrightcoveImage

AddLogoOverlay() public method

Adds a logo overlay image to a video.
public AddLogoOverlay ( BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay logoOverlay, FileUploadInfo fileUploadInfo, long videoId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay
logoOverlay BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay The metadata for the logo overlay you'd like to create (or update).
fileUploadInfo FileUploadInfo Information for the file to be uploaded.
videoId long The ID of the video you want to assign a logo overlay to.
return BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay

AddLogoOverlay() public method

Adds a logo overlay image to a video.
public AddLogoOverlay ( BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay logoOverlay, FileUploadInfo fileUploadInfo, string videoReferenceId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay
logoOverlay BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay The metadata for the logo overlay you'd like to create (or update).
fileUploadInfo FileUploadInfo Information for the file to be uploaded.
videoReferenceId string The reference ID of the video you want to assign a logo overlay to.
return BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay

AddLogoOverlay() public method

Adds a logo overlay image to a video.
public AddLogoOverlay ( BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay logoOverlay, string fileToUpload, long videoId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay
logoOverlay BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay The metadata for the logo overlay you'd like to create (or update).
fileToUpload string The full path of the file to be uploaded.
videoId long The ID of the video you want to assign a logo overlay to.
return BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay

AddLogoOverlay() public method

Adds a logo overlay image to a video.
public AddLogoOverlay ( BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay logoOverlay, string fileToUpload, string videoReferenceId ) : BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay
logoOverlay BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay The metadata for the logo overlay you'd like to create (or update).
fileToUpload string The full path of the file to be uploaded.
videoReferenceId string The reference ID of the video you want to assign a logo overlay to.
return BrightcoveMapiWrapper.Model.Items.BrightcoveLogoOverlay

CreateVideo() public method

Creates a new video using a remote URL rendition. The remote URL should be set in the video renditions.
public CreateVideo ( BrightcoveVideo video ) : long
video BrightcoveMapiWrapper.Model.Items.BrightcoveVideo The metadata for the video you want to create.
return long

CreateVideo() public method

Creates a new video by uploading a file.
public CreateVideo ( BrightcoveVideo video, FileUploadInfo fileUploadInfo, EncodeTo encodeTo, bool createMultipleRenditions, bool preserveSourceRendition, bool h264NoProcessing ) : long
video BrightcoveMapiWrapper.Model.Items.BrightcoveVideo The metadata for the video you want to create.
fileUploadInfo FileUploadInfo Information for the file to be uploaded.
encodeTo EncodeTo If the file requires transcoding, use this parameter to specify the target encoding. /// Valid values are MP4 or FLV, representing the H264 and VP6 codecs respectively. Note that transcoding of /// FLV files to another codec is not currently supported. This parameter is optional and defaults to FLV.
createMultipleRenditions bool If the file is a supported transcodeable type, this optional flag can be /// used to control the number of transcoded renditions. If true (default), multiple renditions at varying encoding /// rates and dimensions are created. Setting this to false will cause a single transcoded VP6 rendition to be created /// at the standard encoding rate and dimensions.
preserveSourceRendition bool If the video file is H.264 encoded and if createMultipleRenditions is true, /// then multiple VP6 renditions are created and in addition the H.264 source is retained as an additional rendition.
h264NoProcessing bool Use this option to prevent H.264 source files from being transcoded. This parameter cannot /// be used in combination with create_multiple_renditions. It is optional and defaults to false.
return long

CreateVideo() public method

Creates a new video by uploading a file.
public CreateVideo ( BrightcoveVideo video, string fileToUpload ) : long
video BrightcoveMapiWrapper.Model.Items.BrightcoveVideo The metadata for the video you want to create.
fileToUpload string The full path to the file to be uploaded.
return long

CreateVideo() public method

Creates a new video by uploading a file.
public CreateVideo ( BrightcoveVideo video, string fileToUpload, EncodeTo encodeTo ) : long
video BrightcoveMapiWrapper.Model.Items.BrightcoveVideo The metadata for the video you want to create.
fileToUpload string The full path to the file to be uploaded.
encodeTo EncodeTo If the file requires transcoding, use this parameter to specify the target encoding. /// Valid values are MP4 or FLV, representing the H264 and VP6 codecs respectively. Note that transcoding of /// FLV files to another codec is not currently supported. This parameter is optional and defaults to FLV.
return long

CreateVideo() public method

Creates a new video by uploading a file.
public CreateVideo ( BrightcoveVideo video, string fileToUpload, EncodeTo encodeTo, bool createMultipleRenditions ) : long
video BrightcoveMapiWrapper.Model.Items.BrightcoveVideo The metadata for the video you want to create.
fileToUpload string The full path to the file to be uploaded.
encodeTo EncodeTo If the file requires transcoding, use this parameter to specify the target encoding. /// Valid values are MP4 or FLV, representing the H264 and VP6 codecs respectively. Note that transcoding of /// FLV files to another codec is not currently supported. This parameter is optional and defaults to FLV.
createMultipleRenditions bool If the file is a supported transcodeable type, this optional flag can be /// used to control the number of transcoded renditions. If true (default), multiple renditions at varying encoding /// rates and dimensions are created. Setting this to false will cause a single transcoded VP6 rendition to be created /// at the standard encoding rate and dimensions.
return long

CreateVideo() public method

Creates a new video by uploading a file.
public CreateVideo ( BrightcoveVideo video, string fileToUpload, EncodeTo encodeTo, bool createMultipleRenditions, bool preserveSourceRendition ) : long
video BrightcoveMapiWrapper.Model.Items.BrightcoveVideo The metadata for the video you want to create.
fileToUpload string The full path to the file to be uploaded.
encodeTo EncodeTo If the file requires transcoding, use this parameter to specify the target encoding. /// Valid values are MP4 or FLV, representing the H264 and VP6 codecs respectively. Note that transcoding of /// FLV files to another codec is not currently supported. This parameter is optional and defaults to FLV.
createMultipleRenditions bool If the file is a supported transcodeable type, this optional flag can be /// used to control the number of transcoded renditions. If true (default), multiple renditions at varying encoding /// rates and dimensions are created. Setting this to false will cause a single transcoded VP6 rendition to be created /// at the standard encoding rate and dimensions.
preserveSourceRendition bool If the video file is H.264 encoded and if createMultipleRenditions is true, /// then multiple VP6 renditions are created and in addition the H.264 source is retained as an additional rendition.
return long

CreateVideo() public method

Creates a new video by uploading a file.
public CreateVideo ( BrightcoveVideo video, string fileToUpload, EncodeTo encodeTo, bool createMultipleRenditions, bool preserveSourceRendition, bool h264NoProcessing ) : long
video BrightcoveMapiWrapper.Model.Items.BrightcoveVideo The metadata for the video you want to create.
fileToUpload string The full path to the file to be uploaded.
encodeTo EncodeTo If the file requires transcoding, use this parameter to specify the target encoding. /// Valid values are MP4 or FLV, representing the H264 and VP6 codecs respectively. Note that transcoding of /// FLV files to another codec is not currently supported. This parameter is optional and defaults to FLV.
createMultipleRenditions bool If the file is a supported transcodeable type, this optional flag can be /// used to control the number of transcoded renditions. If true (default), multiple renditions at varying encoding /// rates and dimensions are created. Setting this to false will cause a single transcoded VP6 rendition to be created /// at the standard encoding rate and dimensions.
preserveSourceRendition bool If the video file is H.264 encoded and if createMultipleRenditions is true, /// then multiple VP6 renditions are created and in addition the H.264 source is retained as an additional rendition.
h264NoProcessing bool Use this option to prevent H.264 source files from being transcoded. This parameter cannot /// be used in combination with create_multiple_renditions. It is optional and defaults to false.
return long

DeleteVideo() public method

Deletes a video, specified by video ID
public DeleteVideo ( long videoId, bool cascade, bool deleteShares ) : void
videoId long The ID of the video you'd like to delete
cascade bool If true, video will be deleted even if it is part of a manual playlist or assigned to /// a player. The video will be removed from all playlists and players in which it appears, then deleted.
deleteShares bool Set this to true if you want also to delete shared copies of this video. Note that /// this will delete all shared copies from your account, as well as from all accounts with which the video has /// been shared, regardless of whether or not those accounts are currently using the video in playlists or players.
return void

DeleteVideo() public method

Deletes a video, specified by the video's reference ID
public DeleteVideo ( string referenceId, bool cascade, bool deleteShares ) : void
referenceId string The reference ID of the video you'd like to delete
cascade bool If true, video will be deleted even if it is part of a manual playlist or assigned to /// a player. The video will be removed from all playlists and players in which it appears, then deleted.
deleteShares bool Set this to true if you want also to delete shared copies of this video. Note that /// this will delete all shared copies from your account, as well as from all accounts with which the video has /// been shared, regardless of whether or not those accounts are currently using the video in playlists or players.
return void

GetUploadStatus() public method

Determines the status of an upload.
public GetUploadStatus ( long videoId ) : BrightcoveUploadStatus
videoId long The ID of the video whose status you'd like to get.
return BrightcoveUploadStatus

GetUploadStatus() public method

Determines the status of an upload.
public GetUploadStatus ( string referenceId ) : BrightcoveUploadStatus
referenceId string The reference ID of the video whose status you'd like to get.
return BrightcoveUploadStatus

RemoveLogoOverlay() public method

Removes a logo overlay previously assigned to a video.
public RemoveLogoOverlay ( long videoId ) : void
videoId long The ID of the video to remove the logo overlay from.
return void

RemoveLogoOverlay() public method

Removes a logo overlay previously assigned to a video.
public RemoveLogoOverlay ( string videoReferenceId ) : void
videoReferenceId string The publisher-assigned reference ID of the video to remove /// the logo overlay from.
return void

ShareVideo() public method

Shares the specified video with a list of sharee accounts.
public ShareVideo ( long videoId, bool autoAccept, bool forceReshare, IEnumerable shareeAccountIds ) : ICollection
videoId long The id for video that will be shared.
autoAccept bool If the target account has the option enabled, setting this flag to true will bypass /// the approval process, causing the shared video to automatically appear in the target account's library. If the /// target account does not have the option enabled, or this flag is unspecified or false, then the shared video /// will be queued up to be approved by the target account before appearing in their library.
forceReshare bool If true, indicates that if the shared video already exists in the target account's /// library, it should be overwritten by the video in the sharer's account.
shareeAccountIds IEnumerable List of Account IDs to share video with.
return ICollection

UnshareVideo() public method

Deletes the specified previously shared video from a list of sharee accounts. If a shared version of the specified video does not exist in a sharee account, no action is taken.
public UnshareVideo ( long videoId, IEnumerable shareeAccountIds ) : ICollection
videoId long The id for the video that is shared.
shareeAccountIds IEnumerable List of Account IDs from which to stop sharing the video.
return ICollection

UpdateVideo() public method

Updates the specified video.
public UpdateVideo ( BrightcoveVideo video ) : BrightcoveVideo
video BrightcoveMapiWrapper.Model.Items.BrightcoveVideo
return BrightcoveMapiWrapper.Model.Items.BrightcoveVideo