Packagecom.adobe.mediacore.metadata
Classpublic class AuditudeSettings
InheritanceAuditudeSettings Inheritance AdvertisingMetadata Inheritance Metadata Inheritance Object

Public class which support ad information provided by the Auditude ad-resolving WEB service.



Public Properties
 PropertyDefined By
 InheritedadBreakAsWatched : String
Sets the ad break watched policy.
AdvertisingMetadata
 InheritedadSignalingMode : String
Sets the signaling metadata used when processing media streams.
AdvertisingMetadata
  creativeRepackagingEnabled : Boolean
Retrieve whether Auditude should perform creative repackaging.
AuditudeSettings
  customParameters : Metadata
The custom parameters.
AuditudeSettings
  defaultMediaId : String
Retrieve the Auditude "default media id" parameter This parameter (known in advance by the developer) is not mandatory, but it highly recommended to be used.
AuditudeSettings
  domain : String
The domain name corresponding to the Auditude service.
AuditudeSettings
  mediaId : String
The Auditude "media id" parameter.
AuditudeSettings
  targetingInfo : Metadata
The custom ad-targeting information.
AuditudeSettings
  zoneId : String
The Auditude "zone id" parameter.
AuditudeSettings
Public Methods
 MethodDefined By
 Inherited
containsKey(key:String):Boolean
Checks if the metadata contains the specified key.
Metadata
 Inherited
getByteArray(key:String):ByteArray
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
Metadata
 Inherited
getMetadata(key:String):Metadata
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
Metadata
 Inherited
getObject(key:String):Object
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
Metadata
 Inherited
getValue(key:String):String
Returns the value associated with the specified key as string.
Metadata
 Inherited
isEmpty():Boolean
Checks if the metadata has any mapping defined.
Metadata
 Inherited
keySet():Vector.<String>
Returns a vector containing the strings used as keys in this metadata.
Metadata
 Inherited
setByteArray(key:String, byteArray:ByteArray):void
Stores a ByteArray value replacing any existing value for the given key.
Metadata
 Inherited
setMetadata(key:String, metadata:Metadata):void
Stores a Metadata value replacing any existing value for the given key.
Metadata
 Inherited
setObject(key:String, object:Object):void
Stores an object value replacing any existing value for the given key.
Metadata
 Inherited
setValue(key:String, value:String):void
Stores a String value into this metadata, replacing any existing value for the given key.
Metadata
 Inherited
toString():String
Returns the string representation of the specified object.
Metadata
Property Detail
creativeRepackagingEnabledproperty
creativeRepackagingEnabled:Boolean

Retrieve whether Auditude should perform creative repackaging. This information is not mandatory to issue valid requests to the Auditude back-end server. The server might be configured to have a pool of ads that are not supported by this platform, such as f4m. When this option is enabled, the Auditude back-end will try to perform on the fly ad transcoding. In this way, ads that are not supported will be repackaged to compliant formats (such as m3u8), seamlessly to the client. The repackaged ad is cached and it will be served directly the next time it is requested.


Implementation
    public function get creativeRepackagingEnabled():Boolean
    public function set creativeRepackagingEnabled(value:Boolean):void
customParametersproperty 
customParameters:Metadata

The custom parameters. The custom parameters are not mandatory to issue valid requests to the Auditude back-end server. This optional parameter can be used to replace certain parameters on the client.


Implementation
    public function get customParameters():Metadata
    public function set customParameters(value:Metadata):void
defaultMediaIdproperty 
defaultMediaId:String

Retrieve the Auditude "default media id" parameter This parameter (known in advance by the developer) is not mandatory, but it highly recommended to be used. This parameter will be used to server ad impressions in the case of faulty configuration or delay in propagation in the Auditude content ingestion and ad server.


Implementation
    public function get defaultMediaId():String
    public function set defaultMediaId(value:String):void
domainproperty 
domain:String

The domain name corresponding to the Auditude service. This parameter (known in advance by the developer) is required in order to be able to issue valid requests to the Auditude back-end server.


Implementation
    public function get domain():String
    public function set domain(value:String):void
mediaIdproperty 
mediaId:String

The Auditude "media id" parameter. This parameter (known in advance by the developer) is required in order to be able to issue valid requests to the Auditude back-end server. This value targets a specific ad-configuration on the Auditude back-end server.


Implementation
    public function get mediaId():String
    public function set mediaId(value:String):void
targetingInfoproperty 
targetingInfo:Metadata

The custom ad-targeting information. The ad-targeting information is not mandatory to issue valid requests to the Auditude back-end server. This optional parameter can be used restrict the pool of ads that are considered during the ad-selection process.


Implementation
    public function get targetingInfo():Metadata
    public function set targetingInfo(value:Metadata):void
zoneIdproperty 
zoneId:String

The Auditude "zone id" parameter. This parameter (known in advance by the developer) is required in order to be able to issue valid requests to the Auditude back-end server.


Implementation
    public function get zoneId():String
    public function set zoneId(value:String):void