REST Resource: networks.daiEncodingProfiles

Resource: DaiEncodingProfile

A DaiEncodingProfile contains data about a publisher's encoding profiles. Ad Manager Dynamic Ad Insertion (DAI) uses the profile information about the content to select an appropriate ad transcode to play for the particular video.

JSON representation 
{
  "name": string,
  "videoSettings": {
    object (VideoSettings)
  },
  "audioSettings": {
    object (AudioSettings)
  },
  "displayName": string,
  "status": enum (DaiEncodingProfileStatus),
  "variantType": enum (DaiEncodingProfileVariantType),
  "containerType": enum (ContainerType)
}
Fields
name

string

Identifier. The resource name of the DaiEncodingProfile. Format: networks/{networkCode}/daiEncodingProfiles/{dai_encoding_profile_id}
videoSettings

object (VideoSettings)

Optional. Information about the video media, if present. This field will only be set if the media contains video, or is an IFRAME variant type.
audioSettings

object (AudioSettings)

Optional. Information about the audio media, if present. This field will only be set if the media contains audio. Only MEDIA and IFRAME variant types can set audio.
displayName

string

Required. The name of the DaiEncodingProfile. It may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, , ~, ;, ^, (, ), <, >, [, ], the white space character.
status

enum (DaiEncodingProfileStatus)

Output only. The status of this DaiEncodingProfile.

DAI encoding profiles are created in the [DaiEncodingProfileStatus.ACTIVE][] state by default.

Only active profiles will be allowed to be associated with live streams.
variantType

enum (DaiEncodingProfileVariantType)

Required. The variant playlist type that this DaiEncodingProfile represents.
containerType

enum (ContainerType)

Required. The digital container type of the underlying media. This is required for MEDIA and IFRAME variant types.

DaiEncodingProfileStatus

The status of the DaiEncodingProfile.

Enums
DAI_ENCODING_PROFILE_STATUS_UNSPECIFIED Not specified value.
ACTIVE Indicates the DaiEncodingProfile has been created and is eligible for streaming.
ARCHIVED Indicates the DaiEncodingProfile has been archived.

DaiEncodingProfileVariantType

The variant type of the DaiEncodingProfile.

Enums
DAI_ENCODING_PROFILE_VARIANT_TYPE_UNSPECIFIED Not specified value.
MEDIA Media variant playlist type. Media playlists may: contain audio only video only, or audio and video.
IFRAME iFrame variant playlist type. iFrame playlists may: contain video or contain audio and video (i.e. video must be present).
SUBTITLES Subtitles variant playlist type.

ContainerType

The container type of the DaiEncodingProfile.

Enums
CONTAINER_TYPE_UNSPECIFIED Not specified value.
TS Transport stream (TS) container.
FMP4 Fragmented MPEG-4 (fMP4) output container.
HLS_AUDIO HTTP live streaming (HLS) packed audio container.

VideoSettings

Information about the video settings of an encoding profile.

JSON representation 
{
  "codec": string,
  "bitrate": string,
  "framesPerSecond": number,
  "resolution": {
    object (Size)
  }
}
Fields
codec

string

Required. The RFC6381 codec string of the video.
bitrate

string (int64 format)

Required. The bitrate of the video, in bits per second. This value must be between 32kbps and 250 Mbps.
framesPerSecond

number

Required. The frames per second of the video. This value will be truncated to three decimal places.
resolution

object (Size)

Required. The resolution of the video, in pixels.

AudioSettings

Information about the audio settings of an encoding profile.

JSON representation 
{
  "codec": string,
  "bitrate": string,
  "channels": string,
  "sampleRateHertz": string
}
Fields
codec

string

Required. The RFC6381 codec string of the audio.
bitrate

string (int64 format)

Required. The bitrate of the audio, in bits per second. This value must be between 8kbps and 250 Mbps.
channels

string (int64 format)

Required. The number of audio channels, including low frequency channels. This value has a maximum of 8.
sampleRateHertz

string (int64 format)

Required. The audio sample rate in hertz. Must be between 44kHz and 100kHz.

Methods

batchActivate

 Activates a list of DaiEncodingProfile objects.

batchArchive

 Archives a list of DaiEncodingProfile objects.

batchCreate

 Batch creates DaiEncodingProfile objects.

batchUpdate

 Batch updates DaiEncodingProfile objects.

create

 Creates a DaiEncodingProfile object.

get

 Retrieves a DaiEncodingProfile object.

list

 Lists DaiEncodingProfile objects.

patch

 Updates a DaiEncodingProfile object.