Web Service: DaiEncodingProfileService

Port type DaiEncodingProfileServiceInterfaceSource code

1. createDaiEncodingProfiles
   Source code
   Description:
   Creates new {@link DaiEncodingProfile} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createDaiEncodingProfilesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createDaiEncodingProfiles

   Creates new {@link DaiEncodingProfile} objects.

   • daiEncodingProfiles - optional, unbounded; type DaiEncodingProfile
     A {@link 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.
     • id - optional; type long
       The unique ID of the {@link DaiEncodingProfile}. This value is read-only and is assigned by Google.
     • name - optional; type string
       The name of the {@link DaiEncodingProfile}. This value is required to create an encoding profile and may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
     • status - optional; type DaiEncodingProfileStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'UNKNOWN' }
       The status of this {@link DaiEncodingProfile}.

       DAI encoding profiles are created in the {@link DaiEncodingProfileStatus#ACTIVE} state. The status can only be modified through the {@link DaiEncodingProfileService#performDaiEncodingProfileAction} method.

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

     • variantType - optional; type VariantType - type string with restriction - enum { 'MEDIA', 'IFRAME', 'SUBTITLES', 'UNKNOWN' }
       The variant playlist type that this {@link DaiEncodingProfile} represents.
     • containerType - optional; type ContainerType - type string with restriction - enum { 'TS', 'FMP4', 'HLS_AUDIO', 'UNKNOWN' }
       The digital container type of the underlying media. This is required for {@code MEDIA} and {@code IFRAME} variant types.
     • videoSettings - optional; type VideoSettings
       Information about the video media, if present. This field will only be set if the media contains video, or is an {@code IFRAME} variant type.
       Information about the video settings of an encoding profile.
       • codec - optional; type string
         The RFC6381 codec string of the audio.
       • bitrate - optional; type long
         The bitrate of the video, in bits per second. This value must be between 32kbps and 250 Mbps.
       • framesPerSecond - optional; type double
         The frames per second of the video. This value will be truncated to three decimal places.
       • resolution - optional; type Size
         Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

         For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

         • width - optional; type int
           The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • height - optional; type int
           The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • isAspectRatio - optional; type boolean
           Whether this size represents an aspect ratio.
         The resolution of the video, in pixels.
     • audioSettings - optional; type AudioSettings
       Information about the audio settings of an encoding profile.
       • codec - optional; type string
         The RFC6381 codec string of the audio.
       • bitrate - optional; type long
         The bitrate of the audio, in bits per second. Required. This value must be between 8kbps and 250 Mbps.
       • channels - optional; type long
         The number of audio channels, including low frequency channels. This value has a maximum of 8.
       • sampleRateHertz - optional; type long
         The audio sample rate in hertz. Must be between 44kHz and 100kHz.
       Information about the audio media, if present. This field will only be set if the media contains audio. Only {@code MEDIA} and {@code IFRAME} variant types can set audio.
   Output:
   createDaiEncodingProfilesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createDaiEncodingProfilesResponse

   • rval - optional, unbounded; type DaiEncodingProfile
     A {@link 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.
     • id - optional; type long
       The unique ID of the {@link DaiEncodingProfile}. This value is read-only and is assigned by Google.
     • name - optional; type string
       The name of the {@link DaiEncodingProfile}. This value is required to create an encoding profile and may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
     • status - optional; type DaiEncodingProfileStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'UNKNOWN' }
       The status of this {@link DaiEncodingProfile}.

       DAI encoding profiles are created in the {@link DaiEncodingProfileStatus#ACTIVE} state. The status can only be modified through the {@link DaiEncodingProfileService#performDaiEncodingProfileAction} method.

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

     • variantType - optional; type VariantType - type string with restriction - enum { 'MEDIA', 'IFRAME', 'SUBTITLES', 'UNKNOWN' }
       The variant playlist type that this {@link DaiEncodingProfile} represents.
     • containerType - optional; type ContainerType - type string with restriction - enum { 'TS', 'FMP4', 'HLS_AUDIO', 'UNKNOWN' }
       The digital container type of the underlying media. This is required for {@code MEDIA} and {@code IFRAME} variant types.
     • videoSettings - optional; type VideoSettings
       Information about the video media, if present. This field will only be set if the media contains video, or is an {@code IFRAME} variant type.
       Information about the video settings of an encoding profile.
       • codec - optional; type string
         The RFC6381 codec string of the audio.
       • bitrate - optional; type long
         The bitrate of the video, in bits per second. This value must be between 32kbps and 250 Mbps.
       • framesPerSecond - optional; type double
         The frames per second of the video. This value will be truncated to three decimal places.
       • resolution - optional; type Size
         Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

         For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

         • width - optional; type int
           The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • height - optional; type int
           The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • isAspectRatio - optional; type boolean
           Whether this size represents an aspect ratio.
         The resolution of the video, in pixels.
     • audioSettings - optional; type AudioSettings
       Information about the audio settings of an encoding profile.
       • codec - optional; type string
         The RFC6381 codec string of the audio.
       • bitrate - optional; type long
         The bitrate of the audio, in bits per second. Required. This value must be between 8kbps and 250 Mbps.
       • channels - optional; type long
         The number of audio channels, including low frequency channels. This value has a maximum of 8.
       • sampleRateHertz - optional; type long
         The audio sample rate in hertz. Must be between 44kHz and 100kHz.
       Information about the audio media, if present. This field will only be set if the media contains audio. Only {@code MEDIA} and {@code IFRAME} variant types can set audio.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
2. getDaiEncodingProfilesByStatement
   Source code
   Description:
   Gets a {@link DaiEncodingProfilePage} of {@link DaiEncodingProfile} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link DaiEncodingProfile#id}
   {@code status}	{@link DaiEncodingProfile#status}
   {@code name}	{@link DaiEncodingProfile#name}

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getDaiEncodingProfilesByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getDaiEncodingProfilesByStatement

   Gets a {@link DaiEncodingProfilePage} of {@link DaiEncodingProfile} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link DaiEncodingProfile#id}
   {@code status}	{@link DaiEncodingProfile#status}
   {@code name}	{@link DaiEncodingProfile#name}

   • filterStatement - optional; type Statement
     Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

     An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

     Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

     An example of such a query might be {@code "WHERE id = :idValue"}.

     Statements also support use of the LIKE keyword. This provides wildcard string matching.

     An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

     The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
     • query - optional; type string
       Holds the query in PQL syntax. The syntax is:
       [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
       

       
            := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
       

     • values - optional, unbounded; type String_ValueMapEntry
       Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

       In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

       This represents an entry in a map with a key of type String and value of type Value.
       • key - optional; type string
       • value - optional; type Value
         {@code Value} represents a value.
   Output:
   getDaiEncodingProfilesByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getDaiEncodingProfilesByStatementResponse

   • rval - optional; type DaiEncodingProfilePage
     Captures a page of {@link DaiEncodingProfile} objects.
     • totalResultSetSize - optional; type int
       The size of the total result set to which this page belongs.
     • startIndex - optional; type int
       The absolute index in the total result set on which this page begins.
     • results - optional, unbounded; type DaiEncodingProfile
       A {@link 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.
       • id - optional; type long
         The unique ID of the {@link DaiEncodingProfile}. This value is read-only and is assigned by Google.
       • name - optional; type string
         The name of the {@link DaiEncodingProfile}. This value is required to create an encoding profile and may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
       • status - optional; type DaiEncodingProfileStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'UNKNOWN' }
         The status of this {@link DaiEncodingProfile}.

         DAI encoding profiles are created in the {@link DaiEncodingProfileStatus#ACTIVE} state. The status can only be modified through the {@link DaiEncodingProfileService#performDaiEncodingProfileAction} method.

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

       • variantType - optional; type VariantType - type string with restriction - enum { 'MEDIA', 'IFRAME', 'SUBTITLES', 'UNKNOWN' }
         The variant playlist type that this {@link DaiEncodingProfile} represents.
       • containerType - optional; type ContainerType - type string with restriction - enum { 'TS', 'FMP4', 'HLS_AUDIO', 'UNKNOWN' }
         The digital container type of the underlying media. This is required for {@code MEDIA} and {@code IFRAME} variant types.
       • videoSettings - optional; type VideoSettings
         Information about the video media, if present. This field will only be set if the media contains video, or is an {@code IFRAME} variant type.
         Information about the video settings of an encoding profile.
         • codec - optional; type string
           The RFC6381 codec string of the audio.
         • bitrate - optional; type long
           The bitrate of the video, in bits per second. This value must be between 32kbps and 250 Mbps.
         • framesPerSecond - optional; type double
           The frames per second of the video. This value will be truncated to three decimal places.
         • resolution - optional; type Size
           Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

           For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

           • width - optional; type int
             The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
           • height - optional; type int
             The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
           • isAspectRatio - optional; type boolean
             Whether this size represents an aspect ratio.
           The resolution of the video, in pixels.
       • audioSettings - optional; type AudioSettings
         Information about the audio settings of an encoding profile.
         • codec - optional; type string
           The RFC6381 codec string of the audio.
         • bitrate - optional; type long
           The bitrate of the audio, in bits per second. Required. This value must be between 8kbps and 250 Mbps.
         • channels - optional; type long
           The number of audio channels, including low frequency channels. This value has a maximum of 8.
         • sampleRateHertz - optional; type long
           The audio sample rate in hertz. Must be between 44kHz and 100kHz.
         Information about the audio media, if present. This field will only be set if the media contains audio. Only {@code MEDIA} and {@code IFRAME} variant types can set audio.
       The collection of profiles contained within this page.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
3. performDaiEncodingProfileAction
   Source code
   Description:
   Performs actions on {@link DaiEncodingProfile} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performDaiEncodingProfileActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performDaiEncodingProfileAction

   Performs actions on {@link DaiEncodingProfile} objects that match the given {@link Statement#query}.

   • daiEncodingProfileAction - optional; type DaiEncodingProfileAction
     Represents the actions that can be performed on {@link DaiEncodingProfile} objects.
     • filterStatement - optional; type Statement
       Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

       An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

       Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

       An example of such a query might be {@code "WHERE id = :idValue"}.

       Statements also support use of the LIKE keyword. This provides wildcard string matching.

       An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

       The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
       • query - optional; type string
         Holds the query in PQL syntax. The syntax is:
         [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
         

         
              := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
         

       • values - optional, unbounded; type String_ValueMapEntry
         Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

         In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

         This represents an entry in a map with a key of type String and value of type Value.
         • key - optional; type string
         • value - optional; type Value
           {@code Value} represents a value.
   Output:
   performDaiEncodingProfileActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performDaiEncodingProfileActionResponse

   • rval - optional; type UpdateResult
     Represents the result of performing an action on objects.
     • numChanges - optional; type int
       The number of objects that were changed as a result of performing the action.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
4. updateDaiEncodingProfiles
   Source code
   Description:
   Updates the specified {@link DaiEncodingProfile} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateDaiEncodingProfilesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateDaiEncodingProfiles

   Updates the specified {@link DaiEncodingProfile} objects.

   • daiEncodingProfiles - optional, unbounded; type DaiEncodingProfile
     A {@link 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.
     • id - optional; type long
       The unique ID of the {@link DaiEncodingProfile}. This value is read-only and is assigned by Google.
     • name - optional; type string
       The name of the {@link DaiEncodingProfile}. This value is required to create an encoding profile and may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
     • status - optional; type DaiEncodingProfileStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'UNKNOWN' }
       The status of this {@link DaiEncodingProfile}.

       DAI encoding profiles are created in the {@link DaiEncodingProfileStatus#ACTIVE} state. The status can only be modified through the {@link DaiEncodingProfileService#performDaiEncodingProfileAction} method.

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

     • variantType - optional; type VariantType - type string with restriction - enum { 'MEDIA', 'IFRAME', 'SUBTITLES', 'UNKNOWN' }
       The variant playlist type that this {@link DaiEncodingProfile} represents.
     • containerType - optional; type ContainerType - type string with restriction - enum { 'TS', 'FMP4', 'HLS_AUDIO', 'UNKNOWN' }
       The digital container type of the underlying media. This is required for {@code MEDIA} and {@code IFRAME} variant types.
     • videoSettings - optional; type VideoSettings
       Information about the video media, if present. This field will only be set if the media contains video, or is an {@code IFRAME} variant type.
       Information about the video settings of an encoding profile.
       • codec - optional; type string
         The RFC6381 codec string of the audio.
       • bitrate - optional; type long
         The bitrate of the video, in bits per second. This value must be between 32kbps and 250 Mbps.
       • framesPerSecond - optional; type double
         The frames per second of the video. This value will be truncated to three decimal places.
       • resolution - optional; type Size
         Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

         For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

         • width - optional; type int
           The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • height - optional; type int
           The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • isAspectRatio - optional; type boolean
           Whether this size represents an aspect ratio.
         The resolution of the video, in pixels.
     • audioSettings - optional; type AudioSettings
       Information about the audio settings of an encoding profile.
       • codec - optional; type string
         The RFC6381 codec string of the audio.
       • bitrate - optional; type long
         The bitrate of the audio, in bits per second. Required. This value must be between 8kbps and 250 Mbps.
       • channels - optional; type long
         The number of audio channels, including low frequency channels. This value has a maximum of 8.
       • sampleRateHertz - optional; type long
         The audio sample rate in hertz. Must be between 44kHz and 100kHz.
       Information about the audio media, if present. This field will only be set if the media contains audio. Only {@code MEDIA} and {@code IFRAME} variant types can set audio.
   Output:
   updateDaiEncodingProfilesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateDaiEncodingProfilesResponse

   • rval - optional, unbounded; type DaiEncodingProfile
     A {@link 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.
     • id - optional; type long
       The unique ID of the {@link DaiEncodingProfile}. This value is read-only and is assigned by Google.
     • name - optional; type string
       The name of the {@link DaiEncodingProfile}. This value is required to create an encoding profile and may be at most 64 characters. The name field can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
     • status - optional; type DaiEncodingProfileStatus - type string with restriction - enum { 'ACTIVE', 'ARCHIVED', 'UNKNOWN' }
       The status of this {@link DaiEncodingProfile}.

       DAI encoding profiles are created in the {@link DaiEncodingProfileStatus#ACTIVE} state. The status can only be modified through the {@link DaiEncodingProfileService#performDaiEncodingProfileAction} method.

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

     • variantType - optional; type VariantType - type string with restriction - enum { 'MEDIA', 'IFRAME', 'SUBTITLES', 'UNKNOWN' }
       The variant playlist type that this {@link DaiEncodingProfile} represents.
     • containerType - optional; type ContainerType - type string with restriction - enum { 'TS', 'FMP4', 'HLS_AUDIO', 'UNKNOWN' }
       The digital container type of the underlying media. This is required for {@code MEDIA} and {@code IFRAME} variant types.
     • videoSettings - optional; type VideoSettings
       Information about the video media, if present. This field will only be set if the media contains video, or is an {@code IFRAME} variant type.
       Information about the video settings of an encoding profile.
       • codec - optional; type string
         The RFC6381 codec string of the audio.
       • bitrate - optional; type long
         The bitrate of the video, in bits per second. This value must be between 32kbps and 250 Mbps.
       • framesPerSecond - optional; type double
         The frames per second of the video. This value will be truncated to three decimal places.
       • resolution - optional; type Size
         Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

         For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

         • width - optional; type int
           The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • height - optional; type int
           The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • isAspectRatio - optional; type boolean
           Whether this size represents an aspect ratio.
         The resolution of the video, in pixels.
     • audioSettings - optional; type AudioSettings
       Information about the audio settings of an encoding profile.
       • codec - optional; type string
         The RFC6381 codec string of the audio.
       • bitrate - optional; type long
         The bitrate of the audio, in bits per second. Required. This value must be between 8kbps and 250 Mbps.
       • channels - optional; type long
         The number of audio channels, including low frequency channels. This value has a maximum of 8.
       • sampleRateHertz - optional; type long
         The audio sample rate in hertz. Must be between 44kHz and 100kHz.
       Information about the audio media, if present. This field will only be set if the media contains audio. Only {@code MEDIA} and {@code IFRAME} variant types can set audio.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.