-
- A Video object (the metadata defining a video). -
- -- This object is defined primarily by the Media API documentation for - a Video object: - http://support.brightcove.com/en/docs/media-api-objects-reference#Video. -
-- This may be modified however from the Media API documentation so that it - can also support other interfaces (e.g. batch provisioning).
-
-
- The Video object is an aggregate of metadata and asset information associated with a video.
-
+
+ A Video object (the metadata defining a video). +
+ ++ This object is defined primarily by the Media API documentation for + a Video object: + http://support.brightcove.com/en/docs/media-api-objects-reference#Video. +
++ This may be modified however from the Media API documentation so that it + can also support other interfaces (e.g. batch provisioning).
+
+
+ The Video object is an aggregate of metadata and asset information associated with a video.
+
@@ -138,28 +138,28 @@
Video()
Video(org.w3c.dom.Element element)
Video(org.json.JSONObject jsonObj)
Video(java.lang.String json)
appendXml(org.w3c.dom.Element root)
getAccountId()
getAdKeys()
getCreationDate()
getCuePoints()
getCustomFields()
getEconomics()
getEndDate()
getFlvUrl()
getGeoFiltered()
getGeoFilteredCountries()
getGeoFilteredExclude()
getId()
getIOSRenditions()
getItemState()
getLastModifiedDate()
getLength()
getLinkText()
getLinkUrl()
getLongDescription()
getName()
getPlaysTotal()
getPlaysTrailingWeek()
getPublishedDate()
getReferenceId()
getRenditions()
getShortDescription()
getStartDate()
getTags()
getThumbnailUrl()
getVideoFullLength()
getVideoStillUrl()
initAll()
setAccountId(java.lang.Long accountId)
setAdKeys(java.lang.String adKeys)
setCreationDate(java.util.Date creationDate)
setCuePoints(java.util.List<CuePoint> cuePoints)
setCustomFields(java.util.List<CustomField> customFields)
setEconomics(EconomicsEnum economics)
setEndDate(java.util.Date endDate)
setFlvUrl(java.lang.String flvUrl)
setGeoFiltered(java.lang.Boolean geoFiltered)
setGeoFilteredCountries(java.util.List<GeoFilterCodeEnum> geoFilteredCountries)
setGeoFilteredExclude(java.lang.Boolean geoFilteredExclude)
setId(java.lang.Long id)
setIOSRenditions(java.util.List<iosRendition> renditions)
setItemState(ItemStateEnum itemState)
setLastModifiedDate(java.util.Date lastModifiedDate)
setLength(java.lang.Long length)
setLinkText(java.lang.String linkText)
setLinkUrl(java.lang.String linkUrl)
setLongDescription(java.lang.String longDescription)
setName(java.lang.String name)
setPlaysTotal(java.lang.Integer playsTotal)
setPlaysTrailingWeek(java.lang.Integer playsTrailingWeek)
setPublishedDate(java.util.Date publishedDate)
setReferenceId(java.lang.String referenceId)
setReleaseDate(java.util.Date releaseDate)
setRenditions(java.util.List<Rendition> renditions)
setShortDescription(java.lang.String shortDescription)
setStartDate(java.util.Date startDate)
setTags(java.util.List<java.lang.String> tags)
setThumbnailUrl(java.lang.String thumbnailUrl)
setVideoFullLength(Rendition videoFullLength)
setVideoStillUrl(java.lang.String videoStillUrl)
toJson()
toJson(java.util.EnumSet<VideoFieldEnum> includeNullFields)
public Video()
- Default Constructor. -
- -- All fields set to null to start - required fields must be set before - calling Write Media API. +
+ Default Constructor. +
+ ++ All fields set to null to start - required fields must be set before + calling Write Media API.
- Constructor using JSON string. -
- -- Given a JSON string from the Media API, attempts to construct a new - Video object and fill out all of the fields defined. All other - fields will be null. +
+ Constructor using JSON string. +
+ ++ Given a JSON string from the Media API, attempts to construct a new + Video object and fill out all of the fields defined. All other + fields will be null.
- Constructor using JSON object. -
- -- Given a JSON object from the Media API, attempts to construct a new - Video object and fill out all of the fields defined. All other - fields will be null. +
+ Constructor using JSON object. +
+ ++ Given a JSON object from the Media API, attempts to construct a new + Video object and fill out all of the fields defined. All other + fields will be null.
public Video(org.w3c.dom.Element element)
- Constructs a new video from an XML representation (generated by Videos.toXml()). +
+ Constructs a new video from an XML representation (generated by Videos.toXml()).
public void initAll()
- Fully initializes the video object by setting all fields to null +
+ Fully initializes the video object by setting all fields to null
public java.lang.String getName()
- Gets the name (title) for this Video. -
- -
-
- Property name: name
+
- Type: String
- Read only?: no
- Description: The title of the Video, limited to 255
- characters. The name is a required property
- when you create a video.
-
+ Gets the name (title) for this Video. +
+ +
+
+ Property name: name
+ Type: String
+ Read only?: no
+ Description: The title of the Video, limited to 255
+ characters. The name is a required property
+ when you create a video.
+
public void setName(java.lang.String name)
- Sets the name (title) for this Video. -
- -
-
- Property name: name
+
- Type: String
- Read only?: no
- Description: The title of the Video, limited to 255
- characters. The name is a required property
- when you create a video.
-
+ Sets the name (title) for this Video. +
+ +
+
+ Property name: name
+ Type: String
+ Read only?: no
+ Description: The title of the Video, limited to 255
+ characters. The name is a required property
+ when you create a video.
+
public java.lang.Long getId()
- Gets the id for this Video. -
- -
-
- Property name: id
+
- Type: long
- Read only?: yes
- Description: A number that uniquely identifies this Video,
- assigned by Brightcove when the Video is
- created.
-
+ Gets the id for this Video. +
+ +
+
+ Property name: id
+ Type: long
+ Read only?: yes
+ Description: A number that uniquely identifies this Video,
+ assigned by Brightcove when the Video is
+ created.
+
public void setId(java.lang.Long id)
- Sets the id for this Video. -
- -
-
- Property name: id
+
- Type: long
- Read only?: yes
- Description: A number that uniquely identifies this Video,
- assigned by Brightcove when the Video is
- created.
-
+ Sets the id for this Video. +
+ +
+
+ Property name: id
+ Type: long
+ Read only?: yes
+ Description: A number that uniquely identifies this Video,
+ assigned by Brightcove when the Video is
+ created.
+
public java.lang.String getReferenceId()
- Gets the reference id for this Video. -
- -
-
- Property name: referenceId
+
- Type: String
- Read only?: no
- Description: A user-specified id that uniquely identifies
- the Video, limited to 150 characters. A
- referenceId can be used as a foreign-key to
- identify this video in another system. Note
- that that the find_videos_by_reference_ids
- method cannot handle a referenceId that contain
- commas, so you may want to avoid using commas
- in referenceId values.
-
+ Gets the reference id for this Video. +
+ +
+
+ Property name: referenceId
+ Type: String
+ Read only?: no
+ Description: A user-specified id that uniquely identifies
+ the Video, limited to 150 characters. A
+ referenceId can be used as a foreign-key to
+ identify this video in another system. Note
+ that that the find_videos_by_reference_ids
+ method cannot handle a referenceId that contain
+ commas, so you may want to avoid using commas
+ in referenceId values.
+
public void setReferenceId(java.lang.String referenceId)
- Sets the reference id for this Video. -
- -
-
- Property name: referenceId
+
- Type: String
- Read only?: no
- Description: A user-specified id that uniquely identifies
- the Video, limited to 150 characters. A
- referenceId can be used as a foreign-key to
- identify this video in another system. Note
- that that the find_videos_by_reference_ids
- method cannot handle a referenceId that contain
- commas, so you may want to avoid using commas
- in referenceId values.
-
+ Sets the reference id for this Video. +
+ +
+
+ Property name: referenceId
+ Type: String
+ Read only?: no
+ Description: A user-specified id that uniquely identifies
+ the Video, limited to 150 characters. A
+ referenceId can be used as a foreign-key to
+ identify this video in another system. Note
+ that that the find_videos_by_reference_ids
+ method cannot handle a referenceId that contain
+ commas, so you may want to avoid using commas
+ in referenceId values.
+
public java.lang.Long getAccountId()
- Gets the account id for this Video. -
- -
-
- Property name: accountId
+
- Type: long
- Read only?: yes
- Description: A number, assigned by Brightcove, that uniquely
- identifies the account to which the Video
- belongs.
-
+ Gets the account id for this Video. +
+ +
+
+ Property name: accountId
+ Type: long
+ Read only?: yes
+ Description: A number, assigned by Brightcove, that uniquely
+ identifies the account to which the Video
+ belongs.
+
public void setAccountId(java.lang.Long accountId)
- Sets the account id for this Video. -
- -
-
- Property name: accountId
+
- Type: long
- Read only?: yes
- Description: A number, assigned by Brightcove, that uniquely
- identifies the account to which the Video
- belongs.
-
+ Sets the account id for this Video. +
+ +
+
+ Property name: accountId
+ Type: long
+ Read only?: yes
+ Description: A number, assigned by Brightcove, that uniquely
+ identifies the account to which the Video
+ belongs.
+
public java.lang.String getShortDescription()
- Gets the short description for this Video. -
- -
-
- Property name: shortDescription
+
- Type: String
- Read only?: no
- Description: A short description describing the Video,
- limited to 250 characters. The shortDescription
- is a required property when you create a video.
-
+ Gets the short description for this Video. +
+ +
+
+ Property name: shortDescription
+ Type: String
+ Read only?: no
+ Description: A short description describing the Video,
+ limited to 250 characters. The shortDescription
+ is a required property when you create a video.
+
public void setShortDescription(java.lang.String shortDescription)
- Sets the short description for this Video. -
- -
-
- Property name: shortDescription
+
- Type: String
- Read only?: no
- Description: A short description describing the Video,
- limited to 250 characters. The shortDescription
- is a required property when you create a video.
-
+ Sets the short description for this Video. +
+ +
+
+ Property name: shortDescription
+ Type: String
+ Read only?: no
+ Description: A short description describing the Video,
+ limited to 250 characters. The shortDescription
+ is a required property when you create a video.
+
public java.lang.String getLongDescription()
- Gets the long description for this Video. -
- -
-
- Property name: longDescription
+
- Type: String
- Read only?: no
- Description: A longer description of this Video, limited to
- 5000 characters.
-
+ Gets the long description for this Video. +
+ +
+
+ Property name: longDescription
+ Type: String
+ Read only?: no
+ Description: A longer description of this Video, limited to
+ 5000 characters.
+
public void setLongDescription(java.lang.String longDescription)
- Sets the long description for this Video. -
- -
-
- Property name: longDescription
+
- Type: String
- Read only?: no
- Description: A longer description of this Video, limited to
- 5000 characters.
-
+ Sets the long description for this Video. +
+ +
+
+ Property name: longDescription
+ Type: String
+ Read only?: no
+ Description: A longer description of this Video, limited to
+ 5000 characters.
+
public java.lang.String getFlvUrl()
- Gets the FLV URL for this Video. -
- -
-
- Property name: FLVURL
+
- Type: String
- Read only?: yes
- Description: The URL of the video file for this Video. Note
- that this property can be accessed with the
- Media API only with a special read or write
- token. This property applies, no matter whether
- the video's encoding is FLV (VP6) or MP4
- (H.264). See
- Accessing Video Content with the Media API.
-
+ Gets the FLV URL for this Video. +
+ +
+
+ Property name: FLVURL
+ Type: String
+ Read only?: yes
+ Description: The URL of the video file for this Video. Note
+ that this property can be accessed with the
+ Media API only with a special read or write
+ token. This property applies, no matter whether
+ the video's encoding is FLV (VP6) or MP4
+ (H.264). See
+ Accessing Video Content with the Media API.
+
public void setFlvUrl(java.lang.String flvUrl)
- Sets the FLV URL for this Video. -
- -
-
- Property name: FLVURL
+
- Type: String
- Read only?: yes
- Description: The URL of the video file for this Video. Note
- that this property can be accessed with the
- Media API only with a special read or write
- token. This property applies, no matter whether
- the video's encoding is FLV (VP6) or MP4
- (H.264). See
- Accessing Video Content with the Media API.
-
+ Sets the FLV URL for this Video. +
+ +
+
+ Property name: FLVURL
+ Type: String
+ Read only?: yes
+ Description: The URL of the video file for this Video. Note
+ that this property can be accessed with the
+ Media API only with a special read or write
+ token. This property applies, no matter whether
+ the video's encoding is FLV (VP6) or MP4
+ (H.264). See
+ Accessing Video Content with the Media API.
+
public java.util.List<Rendition> getRenditions()
- Gets the renditions for this Video. -
- -
-
- Property name: renditions
+
- Type: Array
- Read only?: no
- Description: An array of
- Renditions
- that represent the multi-bitrate streaming
- renditions available for this Video. A Video
- should have not more than 10 Renditions. Note
- that this property can be accessed with the
- Media API only with a special read or write
- token. See
- Accessing Video Content with the Media API.
-
+ Gets the renditions for this Video. +
+ +
+
+ Property name: renditions
+ Type: Array
+ Read only?: no
+ Description: An array of
+ Renditions
+ that represent the multi-bitrate streaming
+ renditions available for this Video. A Video
+ should have not more than 10 Renditions. Note
+ that this property can be accessed with the
+ Media API only with a special read or write
+ token. See
+ Accessing Video Content with the Media API.
+
public void setRenditions(java.util.List<Rendition> renditions)
- Sets the renditions for this Video. -
- -
-
- Property name: renditions
+
- Type: Array
- Read only?: no
- Description: An array of
- Renditions
- that represent the multi-bitrate streaming
- renditions available for this Video. A Video
- should have not more than 10 Renditions. Note
- that this property can be accessed with the
- Media API only with a special read or write
- token. See
- Accessing Video Content with the Media API.
-
+ Sets the renditions for this Video. +
+ +
+
+ Property name: renditions
+ Type: Array
+ Read only?: no
+ Description: An array of
+ Renditions
+ that represent the multi-bitrate streaming
+ renditions available for this Video. A Video
+ should have not more than 10 Renditions. Note
+ that this property can be accessed with the
+ Media API only with a special read or write
+ token. See
+ Accessing Video Content with the Media API.
+
public java.util.List<Rendition> getIOSRenditions()
- Gets the iOS renditions for this Video. -
- -
-
- Property name: iosRenditions
+
- Type: Array
- Read only?: no
- Description:
-
+ Gets the iOS renditions for this Video. +
+ +
+
+ Property name: iosRenditions
+ Type: Array
+ Read only?: no
+ Description:
+
public void setIOSRenditions(java.util.List<iosRendition> renditions)
- Sets the iOS renditions for this Video. -
- -
-
- Property name: iosRenditions
+
- Type: Array
- Read only?: no
- Description:
-
+ Sets the iOS renditions for this Video. +
+ +
+
+ Property name: iosRenditions
+ Type: Array
+ Read only?: no
+ Description:
+
public Rendition getVideoFullLength()
- Gets the full length rendition for this Video. -
- -
-
- Property name: videoFullLength
+
- Type: Rendition
- Read only?: no
- Description: A single
- Rendition
- that represents the the video file for the
- Video. Note that this property can be accessed
- with the Media API only with a special read or
- write token. See
- Accessing Video Content with the Media API.
-
+ Gets the full length rendition for this Video. +
+ +
+
+ Property name: videoFullLength
+ Type: Rendition
+ Read only?: no
+ Description: A single
+ Rendition
+ that represents the the video file for the
+ Video. Note that this property can be accessed
+ with the Media API only with a special read or
+ write token. See
+ Accessing Video Content with the Media API.
+
public void setVideoFullLength(Rendition videoFullLength)
- Sets the full length rendition for this Video. -
- -
-
- Property name: videoFullLength
+
- Type: Rendition
- Read only?: no
- Description: A single
- Rendition
- that represents the the video file for the
- Video. Note that this property can be accessed
- with the Media API only with a special read or
- write token. See
- Accessing Video Content with the Media API.
-
+ Sets the full length rendition for this Video. +
+ +
+
+ Property name: videoFullLength
+ Type: Rendition
+ Read only?: no
+ Description: A single
+ Rendition
+ that represents the the video file for the
+ Video. Note that this property can be accessed
+ with the Media API only with a special read or
+ write token. See
+ Accessing Video Content with the Media API.
+
public java.util.Date getCreationDate()
- Gets the creation date for this Video. -
- -
-
- Property name: creationDate
+
- Type: Date
- Read only?: yes
- Description: The date this Video was created, represented as
- the number of milliseconds since the UNIX
- epoch.
-
+ Gets the creation date for this Video. +
+ +
+
+ Property name: creationDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was created, represented as
+ the number of milliseconds since the UNIX
+ epoch.
+
public void setCreationDate(java.util.Date creationDate)
- Sets the creation date for this Video. -
- -
-
- Property name: creationDate
+
- Type: Date
- Read only?: yes
- Description: The date this Video was created, represented as
- the number of milliseconds since the UNIX
- epoch.
-
+ Sets the creation date for this Video. +
+ +
+
+ Property name: creationDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was created, represented as
+ the number of milliseconds since the UNIX
+ epoch.
+
public java.util.Date getPublishedDate()
- Gets the published date for this Video. -
- -
-
- Property name: publishedDate
+
- Type: Date
- Read only?: yes
- Description: The date this Video was last made active,
- represented as the number of milliseconds since
- the UNIX epoch.
-
+ Gets the published date for this Video. +
+ +
+
+ Property name: publishedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last made active,
+ represented as the number of milliseconds since
+ the UNIX epoch.
+
public void setPublishedDate(java.util.Date publishedDate)
- Sets the published date for this Video. -
- -
-
- Property name: publishedDate
+
- Type: Date
- Read only?: yes
- Description: The date this Video was last made active,
- represented as the number of milliseconds since
- the UNIX epoch.
-
+ Sets the published date for this Video. +
+ +
+
+ Property name: publishedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last made active,
+ represented as the number of milliseconds since
+ the UNIX epoch.
+
public java.util.Date getLastModifiedDate()
- Gets the last modified date for this Video. -
- -
-
- Property name: lastModifiedDate
+
- Type: Date
- Read only?: yes
- Description: The date this Video was last modified,
- represented as the number of milliseconds since
- the UNIX epoch.
-
+ Gets the last modified date for this Video. +
+ +
+
+ Property name: lastModifiedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last modified,
+ represented as the number of milliseconds since
+ the UNIX epoch.
+
public void setLastModifiedDate(java.util.Date lastModifiedDate)
- Sets the last modified date for this Video. -
- -
-
- Property name: lastModifiedDate
+
- Type: Date
- Read only?: yes
- Description: The date this Video was last modified,
- represented as the number of milliseconds since
- the UNIX epoch.
-
+ Sets the last modified date for this Video. +
+ +
+
+ Property name: lastModifiedDate
+ Type: Date
+ Read only?: yes
+ Description: The date this Video was last modified,
+ represented as the number of milliseconds since
+ the UNIX epoch.
+
public java.util.Date getReleaseDate()
Gets the release date for this Video.
- -
-
- undocumented
-
+
Gets the release date for this Video.
+ +
+
+ undocumented
+
public void setReleaseDate(java.util.Date releaseDate)
- Sets the release date for this Video. -
- -
-
- undocumented
-
+
+ Sets the release date for this Video. +
+ +
+
+ undocumented
+
public ItemStateEnum getItemState()
- Gets the item state for this Video. -
- -
-
- Property name: itemState
+
- Type: Enum
- Read only?: no
- Description: An
- ItemStateEnum.
- One of the properties: ACTIVE, INACTIVE, or
- DELETED. You can set this property only to
- ACTIVE or INACTIVE; you cannot delete a video
- by setting its itemState to DELETED.
-
+ Gets the item state for this Video. +
+ +
+
+ Property name: itemState
+ Type: Enum
+ Read only?: no
+ Description: An
+ ItemStateEnum.
+ One of the properties: ACTIVE, INACTIVE, PENDING, or
+ DELETED. You can set this property only to
+ ACTIVE or INACTIVE; you cannot delete a video
+ by setting its itemState to DELETED.
+
public void setItemState(ItemStateEnum itemState)
- Sets the item state for this Video. -
- -
-
- Property name: itemState
+
- Type: Enum
- Read only?: no
- Description: An
- ItemStateEnum.
- One of the properties: ACTIVE, INACTIVE, or
- DELETED. You can set this property only to
- ACTIVE or INACTIVE; you cannot delete a video
- by setting its itemState to DELETED.
-
+ Sets the item state for this Video. +
+ +
+
+ Property name: itemState
+ Type: Enum
+ Read only?: no
+ Description: An
+ ItemStateEnum.
+ One of the properties: ACTIVE, INACTIVE, PENDING or
+ DELETED. You can set this property only to
+ ACTIVE or INACTIVE; you cannot delete a video
+ by setting its itemState to DELETED.
+
public java.util.Date getStartDate()
- Gets the start date for this Video. -
- -
-
- Property name: startDate
+
- Type: Date
- Read only?: no
- Description: The first date this Video is available to be
- played, represented as the number of
- milliseconds since the UNIX epoch.
-
+ Gets the start date for this Video. +
+ +
+
+ Property name: startDate
+ Type: Date
+ Read only?: no
+ Description: The first date this Video is available to be
+ played, represented as the number of
+ milliseconds since the UNIX epoch.
+
public void setStartDate(java.util.Date startDate)
- Sets the start date for this Video. -
- -
-
- Property name: startDate
+
- Type: Date
- Read only?: no
- Description: The first date this Video is available to be
- played, represented as the number of
- milliseconds since the UNIX epoch.
-
+ Sets the start date for this Video. +
+ +
+
+ Property name: startDate
+ Type: Date
+ Read only?: no
+ Description: The first date this Video is available to be
+ played, represented as the number of
+ milliseconds since the UNIX epoch.
+
public java.util.Date getEndDate()
- Gets the end date for this Video. -
- -
-
- Property name: endDate
+
- Type: Date
- Read only?: no
- Description: The last date this Video is available to be
- played, represented as the number of
- milliseconds since the UNIX epoch.
-
+ Gets the end date for this Video. +
+ +
+
+ Property name: endDate
+ Type: Date
+ Read only?: no
+ Description: The last date this Video is available to be
+ played, represented as the number of
+ milliseconds since the UNIX epoch.
+
public void setEndDate(java.util.Date endDate)
- Sets the end date for this Video. -
- -
-
- Property name: endDate
+
- Type: Date
- Read only?: no
- Description: The last date this Video is available to be
- played, represented as the number of
- milliseconds since the UNIX epoch.
-
+ Sets the end date for this Video. +
+ +
+
+ Property name: endDate
+ Type: Date
+ Read only?: no
+ Description: The last date this Video is available to be
+ played, represented as the number of
+ milliseconds since the UNIX epoch.
+
public java.lang.String getLinkUrl()
- Gets the related link URL for this Video. -
- -
-
- Property name: linkURL
+
- Type: String
- Read only?: no
- Description: An optional URL to a related item, limited to
- 255 characters.
-
+ Gets the related link URL for this Video. +
+ +
+
+ Property name: linkURL
+ Type: String
+ Read only?: no
+ Description: An optional URL to a related item, limited to
+ 255 characters.
+
public void setLinkUrl(java.lang.String linkUrl)
- Sets the related link URL for this Video. -
- -
-
- Property name: linkURL
+
- Type: String
- Read only?: no
- Description: An optional URL to a related item, limited to
- 255 characters.
-
+ Sets the related link URL for this Video. +
+ +
+
+ Property name: linkURL
+ Type: String
+ Read only?: no
+ Description: An optional URL to a related item, limited to
+ 255 characters.
+
public java.lang.String getLinkText()
- Gets the related link text for this Video. -
- -
-
- Property name: linkText
+
- Type: String
- Read only?: no
- Description: The text displayed for the linkURL, limited to
- 255 characters.
-
+ Gets the related link text for this Video. +
+ +
+
+ Property name: linkText
+ Type: String
+ Read only?: no
+ Description: The text displayed for the linkURL, limited to
+ 255 characters.
+
public void setLinkText(java.lang.String linkText)
- Sets the related link text for this Video. -
- -
-
- Property name: linkText
+
- Type: String
- Read only?: no
- Description: The text displayed for the linkURL, limited to
- 255 characters.
-
+ Sets the related link text for this Video. +
+ +
+
+ Property name: linkText
+ Type: String
+ Read only?: no
+ Description: The text displayed for the linkURL, limited to
+ 255 characters.
+