Asset Properties by Asset Types

Some basic properties are common to all assets, regardless of their type.

The following table describes all properties that can be associated with an asset. Some properties are used only with specific asset types.
Note:
  • Unless stated otherwise below for a property, there are no default values.
  • Examples of these properties are in the sections on individual types of assets.
Property Description For Asset Types Required?
all_day

Recurring only. Specifies whether the content can be viewed during the entire day. If set to false, specify a start and end time.

Type: Boolean

Valid Values: true | false

Default: true

Example: true

Parent: time_restrictions

all No
asset_type

Type of asset.

Type: String

Valid Values: video | ad | audio | remote_asset | youtube | live_stream | live_audio | channel | channel_set

Example: "video"

all Yes
backup_entry_point For RTMP streams only, URL of secondary source of live stream.

Type: String

Example: "rtmp://a.ep12372.i.akamaientrypoint.net/EntryPoint"
live_stream Yes
bitrate

Bit rate of the encoding.

Type: Integer

Example: 300

Parent: encodings

live_stream No
chunk_size

Size of the chunks to upload, in bytes.

Type: Integer

Example: "10000"

video, audio, ad Yes
click_url

URL to go to when ad is clicked

Type: String

ad No
closed_captions_url The URL for the closed captions file for this asset.

Type: String

Example: "http://my.closedcaptionssite.com/dxfpfile.dxfp"

all No
created_at

Read only. Date and time the video was processed.

Type: DateTime

Example: "2011-04-25T15:32:57+00:00"

all No
description
Description of the asset.
Note: Cannot contain hidden characters, which are those with ASCII values between 0 and 31, except for 10 (newline) and 13 (carriage return).

Type: String

Example: "Season 22 Opening Game"

all No
disable_seek_for_standalone

Do not allow viewers to manually advance or reverse the ad when it is embedded by itself or in a channel

Type: String

Valid Values: true | false

Default: false

ad No
duration

Length of the video, in milliseconds.

Type: Integer

Conditions: Required for remote assets unless is_live_stream is set true, in which case, duration is optional.

Example: "120"

remote_asset No
embed_code

Read only. Content ID of the asset that was assigned by Backlot when the asset was created.

Type: String

Example: "IzNnllMjphu2XF3_UgPROoCi9B2Bwrde"

all No
embeddable

Specifies whether the player showing the video can be embedded.

Type: Boolean

Valid Values: true | false

Default: true

Example: true

Parent: youtube_syndication_settings

youtube No
encodings

Specifies available encodings.

Type: Container

live_stream No
end_date

End date of the restriction.

Type: DateTime (range) or Date (recurring)

Default: None (does not end)

Example: "2011-08-09T21:21:49-07:00" or 2011-08-09

Parent: time_restrictions

all No
end_time

Recurring only. Specifies the end time when content can play.

Type: Time

Default: 23:59:59

Example: 21:00:00

Parent: time_restrictions

all No
external_id

A custom identifier you define that you can use instead of the content ID (embed_code).

Type: String

Example: "my_movie.avi"

all No
file_name

Name of the file that you specify when uploading the asset.

Type: String

Example: "my_movie.avi"

video, audio Yes
file_size

Size of the file, in bytes.

Type: Integer

Example: "20000"

video, audio, ad Yes
flash

Specifies the URL of the Flash stream.

Type: String

Example: "http://example.com/my_flash_file.flv"

Parent: stream_urls

remote_asset No
height

Height of the encoding in pixels.

Type: Integer

Example: 600

Parent: encodings

live_stream No
hosted_at

The permanent URL at which you embed the asset.

Type: String

Example: "http://example.com"

remote_asset No
ipad
Specifies the URL of the iPad stream.
Note: Only MP4 or M3U8 formats are valid.

Type: String

Example: "http://example.com/ipad_compatible_file.mp4"

Parent: stream_urls

remote_asset No
iphone
Specifies the URL of the iPhone stream.
Note: Only MP4 or M3U8 formats are valid.

Type: String

Example: "http://example.com/iphone_compatible_file.mp4"

Parent: stream_urls

remote_asset No
is_flash

Specifies whether the live stream is available in Flash.

Type: Boolean

Valid Values: true | false

Default: true

Example: false

live_stream No
is_ios

Specifies whether the stream live stream is available in iOS.

Type: Boolean

Valid Values: true | false

Default: false

Example: true

live_stream No
is_live_stream

Specifies whether this is a live stream. If the remote asset is a live stream, set this to true. Otherwise, set this to false.

Type: Boolean

Valid Values: true | false

Default: false

Example: false

remote_asset No
itunes

Specifies the URL of the iTunes stream.

Type: String

Example: "http://example.com/itunes_compatible_file.flv"

Parent: stream_urls

remote_asset No
keywords

Specifies keywords for the video.

Type: Array

Example: ["Hockey", "Ballet", "Trainspotting"]

Parent: youtube_syndication_settings

youtube No
mobile

Specifies whether the video can be viewed on mobile devices.

Type: Boolean

Valid Values: true | false

Default: true

Example: true

Parent: youtube_syndication_settings

youtube No
name
Name of the asset.
Note: Cannot contain hidden characters, which are those with ASCII values between 0 and 31, except for 10 (newline) and 13 (carriage return).

Type: String

Example: "My Movie"

all Yes
original_file_name

Name of the file that was specified when uploading the asset.

Type: String

Example: "my_movie.avi"

video, audio Yes
password

For live_stream asset: Password of the primary encoder.

For youtube asset: YouTube account password

Type: String

Example: "shhhh...itsasecret"

Parent for youtube: youtube_syndication_settings

live_stream, youtube Yes
primary_encoder_ip

For all streams other than RTMP, IP address of the primary encoder.

Type: IP Address

Example: "8.8.8.8"

live_stream Yes
primary_entry_point For RTMP streams only, URL of primary source of live stream.

Type: String

Example: "rtmp://a.ep12372.i.akamaientrypoint.net/EntryPoint"
live_stream Yes
private

Specifies whether the video is private. When set to true, the video is unavailable for viewing.

Type: Boolean

Valid Values: true | false

Default: false

Example: false

Parent: youtube_syndication_settings

youtube No
publishing_rule_id Identifier of publishing rule associated with the asset, if any.

Type: String

Example: ru1ze4ea4e648fd07d4509123254

all No
recurring_days

Recurring only. List of days which the content can be viewed.

Type: Array

Valid Values: "SUN" | "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT"

Default: None (all days)

Example: ["SUN", "FRI", "SAT"]

Parent: time_restrictions

all No
source_file

Specifies the file representing the source stream.

Type: String

Example: "source_file.flv"

Parent: stream_urls

remote_asset No
start_date

Start date of the restriction.

Type: DateTime (range) or Date (recurring)

Default: None (starts immediately)

Example: "2011-05-09T21:21:49-07:00" or 2011-05-09

Parent: time_restrictions

all No
start_time

Recurring only. Specifies the start time when content can play.

Type: Time

Default: 0:00:00

Example: 20:00:00

Parent: time_restrictions

all No
status Sets the post-processing (post-transcoding) status of the asset.

Type: String

Valid Values: live | paused

Default: live

Example: "http://my.closedcaptionssite.com/dxfpfile.dxfp"

all No
status

Returns the status of the video.

Type: String

Valid Values: uploading | processing | paused | live

Example: "uploading"

all No
stream_urls

Specifies the stream URLs.

Type: Container

remote_asset No
time_restrictions

Specifies time restrictions for the asset.

Type: Container

Default: None. Restrictions inherited from publishing rule, if any

all No
tracking_pixel_urls

Comma-delimited list of URLs for tracking pixels

Type: String

Example: tracking_pixel_urls: [ "http://trackingpixelurl.com","http://trackingurl.net" ]

ad No
type

Specifies whether this is a recurring or one-time range restriction.

Type: String

Valid Values: "range" | "recurring"

Example: "range"

Parent: time_restrictions

all No
updated_at

Read only. Date and time the video was last modified.

Type: DateTime

Example: "2011-04-25T15:32:57+00:00"

all No
width

Width of the encoding in pixels.

Type: Integer

Example: 800

Parent: encodings

live_stream No
youtube_id

Identifier of the YouTube video. To find the YouTube identifier, locate the v request parameter within the YouTube URL. For example, for the URL www.youtube.com?v=dQw4w9WgXcQ, the YouTube ID is dQw4w9WgXcQ .

Type: String

Example: "dQw4w9WgXcQ"

youtube Yes
youtube_syndication_settings

Contains YouTube syndication settings.

Type: Container

video No

Was this article helpful?