Back to Exoplayer

CmcdConfiguration (ExoPlayer library)

docs/doc/reference/com/google/android/exoplayer2/upstream/CmcdConfiguration.html

latest16.8 KB
Original Source

Package com.google.android.exoplayer2.upstream

Class CmcdConfiguration


[@Deprecated](https://developer.android.com/reference/java/lang/Deprecated.html "class or interface in java.lang")public final classCmcdConfigurationextends[Object](https://developer.android.com/reference/java/lang/Object.html "class or interface in java.lang")

Deprecated. com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.

Represents a configuration for the Common Media Client Data (CMCD) logging.

Nested Class Summary

Nested Classes | Modifier and Type | Class | Description | | --- | --- | --- | | static interface | CmcdConfiguration.CmcdKey | Deprecated.

Indicates that the annotated element represents a CMCD key. | | static interface | CmcdConfiguration.Factory | Deprecated.

Factory for CmcdConfiguration instances. | | static interface | CmcdConfiguration.HeaderKey | Deprecated.

Header keys SHOULD be allocated to one of the four defined header names based upon their expected level of variability: CMCD-Object: keys whose values vary with the object being requested. | | static interface | CmcdConfiguration.RequestConfig | Deprecated.

Represents configuration which can vary on each request. |

Field Summary

Fields | Modifier and Type | Field | Description | | --- | --- | --- | | String | contentId | Deprecated.

A GUID identifying the current content, or null if unset. | | static String | KEY_BITRATE | Deprecated. | | static String | KEY_BUFFER_LENGTH | Deprecated. | | static String | KEY_CMCD_OBJECT | Deprecated. | | static String | KEY_CMCD_REQUEST | Deprecated. | | static String | KEY_CMCD_SESSION | Deprecated. | | static String | KEY_CMCD_STATUS | Deprecated. | | static String | KEY_CONTENT_ID | Deprecated. | | static String | KEY_MAXIMUM_REQUESTED_BITRATE | Deprecated. | | static String | KEY_MEASURED_THROUGHPUT | Deprecated. | | static String | KEY_OBJECT_DURATION | Deprecated. | | static String | KEY_OBJECT_TYPE | Deprecated. | | static String | KEY_SESSION_ID | Deprecated. | | static String | KEY_STREAM_TYPE | Deprecated. | | static String | KEY_STREAMING_FORMAT | Deprecated. | | static String | KEY_TOP_BITRATE | Deprecated. | | static String | KEY_VERSION | Deprecated. | | static int | MAX_ID_LENGTH | Deprecated.

Maximum length for ID fields. | | CmcdConfiguration.RequestConfig | requestConfig | Deprecated.

Dynamic request specific configuration. | | String | sessionId | Deprecated.

A GUID identifying the current playback session, or null if unset. |

Constructor Summary

Constructors | Constructor | Description | | --- | --- | | CmcdConfiguration​(String sessionId, String contentId, CmcdConfiguration.RequestConfig requestConfig) | Deprecated.

Creates an instance. |

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods | Modifier and Type | Method | Description | | --- | --- | --- | | boolean | isBitrateLoggingAllowed() | Deprecated.

Returns whether logging bitrate is allowed based on the request configuration. | | boolean | isBufferLengthLoggingAllowed() | Deprecated.

Returns whether logging buffer length is allowed based on the request configuration. | | boolean | isContentIdLoggingAllowed() | Deprecated.

Returns whether logging content ID is allowed based on the request configuration. | | boolean | isMaximumRequestThroughputLoggingAllowed() | Deprecated.

Returns whether logging maximum requested throughput is allowed based on the request configuration. | | boolean | isMeasuredThroughputLoggingAllowed() | Deprecated.

Returns whether logging measured throughput is allowed based on the request configuration. | | boolean | isObjectDurationLoggingAllowed() | Deprecated.

Returns whether logging object duration is allowed based on the request configuration. | | boolean | isObjectTypeLoggingAllowed() | Deprecated.

Returns whether logging object type is allowed based on the request configuration. | | boolean | isSessionIdLoggingAllowed() | Deprecated.

Returns whether logging session ID is allowed based on the request configuration. | | boolean | isStreamingFormatLoggingAllowed() | Deprecated.

Returns whether logging streaming format is allowed based on the request configuration. | | boolean | isStreamTypeLoggingAllowed() | Deprecated.

Returns whether logging stream type is allowed based on the request configuration. | | boolean | isTopBitrateLoggingAllowed() | Deprecated.

Returns whether logging top bitrate is allowed based on the request configuration. |

- 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

- 

MAX_ID_LENGTH

public static final int MAX_ID_LENGTH

Deprecated.

Maximum length for ID fields. See Also:Constant Field Values

- 

KEY_CMCD_OBJECT

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_CMCD_OBJECT

Deprecated. See Also:Constant Field Values

- 

KEY_CMCD_REQUEST

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_CMCD_REQUEST

Deprecated. See Also:Constant Field Values

- 

KEY_CMCD_SESSION

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_CMCD_SESSION

Deprecated. See Also:Constant Field Values

- 

KEY_CMCD_STATUS

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_CMCD_STATUS

Deprecated. See Also:Constant Field Values

- 

KEY_BITRATE

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_BITRATE

Deprecated. See Also:Constant Field Values

- 

KEY_BUFFER_LENGTH

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_BUFFER_LENGTH

Deprecated. See Also:Constant Field Values

- 

KEY_CONTENT_ID

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_CONTENT_ID

Deprecated. See Also:Constant Field Values

- 

KEY_SESSION_ID

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_SESSION_ID

Deprecated. See Also:Constant Field Values

- 

KEY_MAXIMUM_REQUESTED_BITRATE

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_MAXIMUM_REQUESTED_BITRATE

Deprecated. See Also:Constant Field Values

- 

KEY_STREAMING_FORMAT

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_STREAMING_FORMAT

Deprecated. See Also:Constant Field Values

- 

KEY_STREAM_TYPE

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_STREAM_TYPE

Deprecated. See Also:Constant Field Values

- 

KEY_VERSION

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_VERSION

Deprecated. See Also:Constant Field Values

- 

KEY_TOP_BITRATE

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_TOP_BITRATE

Deprecated. See Also:Constant Field Values

- 

KEY_OBJECT_DURATION

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_OBJECT_DURATION

Deprecated. See Also:Constant Field Values

- 

KEY_MEASURED_THROUGHPUT

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_MEASURED_THROUGHPUT

Deprecated. See Also:Constant Field Values

- 

KEY_OBJECT_TYPE

public static final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")KEY_OBJECT_TYPE

Deprecated. See Also:Constant Field Values

- 

sessionId

@Nullable
public final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")sessionId

Deprecated.

A GUID identifying the current playback session, or null if unset.

A playback session typically ties together segments belonging to a single media asset. Maximum length is 64 characters.

- 

contentId

@Nullable
public final[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")contentId

Deprecated.

A GUID identifying the current content, or null if unset.

This value is consistent across multiple different sessions and devices and is defined and updated at the discretion of the service provider. Maximum length is 64 characters.

- 

requestConfig

public final[CmcdConfiguration.RequestConfig](CmcdConfiguration.RequestConfig.html "interface in com.google.android.exoplayer2.upstream")requestConfig

Deprecated.

Dynamic request specific configuration.

Constructor Detail

- 

CmcdConfiguration

public CmcdConfiguration​(@Nullable[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")sessionId,
                         @Nullable[String](https://developer.android.com/reference/java/lang/String.html "class or interface in java.lang")contentId,[CmcdConfiguration.RequestConfig](CmcdConfiguration.RequestConfig.html "interface in com.google.android.exoplayer2.upstream")requestConfig)

Deprecated.

Creates an instance.

Method Detail

- 

isBitrateLoggingAllowed

public boolean isBitrateLoggingAllowed()

Deprecated.

Returns whether logging bitrate is allowed based on the request configuration.

- 

isBufferLengthLoggingAllowed

public boolean isBufferLengthLoggingAllowed()

Deprecated.

Returns whether logging buffer length is allowed based on the request configuration.

- 

isContentIdLoggingAllowed

public boolean isContentIdLoggingAllowed()

Deprecated.

Returns whether logging content ID is allowed based on the request configuration.

- 

isSessionIdLoggingAllowed

public boolean isSessionIdLoggingAllowed()

Deprecated.

Returns whether logging session ID is allowed based on the request configuration.

- 

isMaximumRequestThroughputLoggingAllowed

public boolean isMaximumRequestThroughputLoggingAllowed()

Deprecated.

Returns whether logging maximum requested throughput is allowed based on the request configuration.

- 

isStreamingFormatLoggingAllowed

public boolean isStreamingFormatLoggingAllowed()

Deprecated.

Returns whether logging streaming format is allowed based on the request configuration.

- 

isStreamTypeLoggingAllowed

public boolean isStreamTypeLoggingAllowed()

Deprecated.

Returns whether logging stream type is allowed based on the request configuration.

- 

isTopBitrateLoggingAllowed

public boolean isTopBitrateLoggingAllowed()

Deprecated.

Returns whether logging top bitrate is allowed based on the request configuration.

- 

isObjectDurationLoggingAllowed

public boolean isObjectDurationLoggingAllowed()

Deprecated.

Returns whether logging object duration is allowed based on the request configuration.

- 

isMeasuredThroughputLoggingAllowed

public boolean isMeasuredThroughputLoggingAllowed()

Deprecated.

Returns whether logging measured throughput is allowed based on the request configuration.

- 

isObjectTypeLoggingAllowed

public boolean isObjectTypeLoggingAllowed()

Deprecated.

Returns whether logging object type is allowed based on the request configuration.