Type Alias CmcdRequestBeta

Type declaration

• Optionalab?: number

  Aggregate encoded bitrate

  The aggregate encoded bitrate of the complete media object including all object types. This SHOULD be derived from playlist/manifest declarations, or it MAY be estimated by the player. If the playlist declares both peak and average bitrate values, the peak value MUST be transmitted. This value MUST NOT be sent for objects which do not have an object type of ‘a’, ‘v’, ‘av’ or ‘o’. This value MUST NOT be sent if the encoded bitrate is known.

  Integer kbps

• Optionalbg?: boolean

  Backgrounded (all players in session not visible, boolean)

  All players in a session are currently in a state that is not visible to the user. This key SHOULD only be sent if it is TRUE. If the visibility state of the player is not known this key SHOULD NOT be reported

  Bool

• Optionalbsd?: number

  Buffer starvation duration

  Duration of the latest rebuffering period reported once the rebuffering has completed. This value MUST only be reported once per rebuffering incident, per object type.

  If the object type ‘ot’ key is sent along with this key, then the ‘bsd’ key refers to the buffer associated with the particular object type. If no object type is communicated, then the buffer state applies to the current session.

  Integer milliseconds

• Optionalcdn?: string

  CDN ID (string, max 128 chars)

  A string identifying the current delivery network from which the player is retrieving content. Maximum length is 128 characters

  String

• Optionalcs?: number

  Content Signature

  A string representing a signature of the content being played. This field SHOULD vary with content ID and be bound by some mechanism to the content. For example, this field may be used to transmit the C2PA signature associated with the content being viewed.

  Integer bytes

• Optionaldf?: number

  Dropped Frames

  An absolute count of dropped frames since session initiation. This key should only be sent for content types of 'v','av' or 'o'. Note that this value will be driven by the content being rendered rather than the content being retrieved, therefore it is beneficial if accompanied by the playhead time 'pt' key to allow for correct interpretation.

  Integer

• Optionalec?: string | string[]

  Error code(s), application-defined

  A string defining an error code produced by the player. The namespace and formatting of this error code is left to the application. Use of standardized error codes is recommended. Errors should be buffered per report destination as they occur and reported along with the next CMCD report. With Event mode there is the option to report errors as they occur.

  An Inner List of Strings

• Optionallab?: number

  Lowest aggregated encoded bitrate (kbps)

  The lowest aggregated bitrate rendition in the manifest or playlist. This SHOULD be derived from playlist/manifest declarations, or it MAY be estimated by the player. If the playlist declares both peak and average bitrate values, the peak value MUST be transmitted. The aggregate encoded bitrate is of the complete media object including all object types. This value MUST NOT be sent for objects which do not have an object type of ‘a’, ‘v’, ‘av’ or ‘c’. This value MUST NOT be sent if the lowest encoded bitrate is known.

  Integer Kbps

• Optionallb?: number

  Lowest encoded bitrate (kbps)

  The lowest bitrate rendition in the manifest or playlist. This SHOULD be derived from playlist/manifest declarations, or it MAY be estimated by the player. If the playlist declares both peak and average bitrate values, the peak value MUST be transmitted. This lowest bitrate MUST apply to the object type being requested. Requests for video objects MUST specify the lowest video bitrate and requests for audio objects MUST specify the lowest audio bitrate. This value MUST NOT be sent for objects which do not have an object type of ‘a’, ‘v’, ‘av’ or ‘c’.

  Integer Kbps

• Optionalltc?: number

  Live stream latency (ms)

  The time delta between when a given media timestamp was made available at the origin and when it was rendered by the client. The accuracy of this estimate is dependent on synchronization between the packager and the player clocks.

  Integer Milliseconds

• Optionalmsd?: number

  Media Start Delay (ms)

  Measures the initial delay in wall-clock time from when a player is instructed to play media for a given session to when any media begins playback, whether it be primary content or interstitial content. This value SHOULD be the time difference between the "starting" and "playing" states. This key MUST only be sent once per Session ID and MUST be sent for each reporting mode which is active within the player. For request and response reporting modes, this key SHOULD be sent on the next media object request following successful startup.

  Integer milliseconds

• Optionalpb?: number

  The encoded bitrate of the audio or video object being shown to the end user.

  Integer Kbps

• Optionalpt?: number

  Playhead time (ms)

  The playhead time, expressed in milliseconds, which is being rendered to the viewer when the report is made. For Response and State-Interval modes, this corresponds to the playhead time that was rendered at the wallclock time reported by the timestamp field.

  Integer milliseconds

• Optionalsn?: number

  Sequence Number

  A monotonically increasing integer to identify the sequence of a CMCD report to a target within a session. This MUST be reset to zero on the start of a new session-id. Sequence numbers increase independently per each combination of mode and target.

  Integer

• Optionalsta?: CmcdPlayerState

  State (player state, e.g. "s", "p", etc.)

  A token describing the current playback state of the player as perceived by the end user, one of: s - starting: the player has been instructed to play media for a given session, either by a user interaction or by an autoplay action. p - playing : Media is being rendered. k - seeking : The start of the user initiated action of moving the playhead position. r - rebuffering : Media has stopped being rendered due to an insufficient buffer. This state is not reported during startup or seeking. a - paused : Playback has been intentionally paused by the user. w - waiting : Playback has been paused by the player. e - ended : Rendering has ended due to completion of the media asset playback. f - fatal error : Rendering has ended due to an irrecoverable error. q - quit : User initiated end of playback before media asset completion. d - preloading : the player is loading assets ahead of starting in order to provide a fast startup. The expectation is that playback will commence at a future time.

  Note: if used with Request Mode or Response Mode, then this key represents a snapshot of the state at request time, which may obscure prior state changes since the last request. For most accurate state tracking in players, use State-Interval mode. The addition of a timestamp in Request Mode might be useful in correctly placing the state change on a timeline.

  Token - one of [s,p,k,r,a,w,e,f,q,d]

• Optionaltab?: number

  Top aggregated encoded bitrate (kbps)

  The highest aggregated bitrate rendition in the manifest or playlist. This SHOULD be derived from playlist/manifest declarations, or it MAY be estimated by the player. If the playlist declares both peak and average bitrate values,the peak value MUST be transmitted. The aggregate encoded bitrate is of the complete media object including all object types. This value MUST NOT be sent for objects which do not have an object type of ‘a’, ‘v’, ‘av’ or ‘c’. This value MUST NOT be sent if the top encoded bitrate is known

  Integer Kbps

• Optionaltbl?: number

  Target buffer length (ms)

  The target buffer length associated with the media object being requested at the time of the request. This value SHOULD be rounded to the nearest 100 ms. This value MUST NOT be sent for objects which do not have an object type of ‘a’, ‘v’, ‘av’, ‘tt’, ‘c’, or ‘o’

  Integer milliseconds

• Optionaltpb?: number

  Top playable bitrate (kbps)

  The highest bitrate rendition that the player is currently capable of playing for reasons other than bandwidth limitations. This key captures the cases in which, for example, screen resolution, DRM, or performance constraints limit the player's topmost choice of bitrate. These constraints are intentionally obfuscated for privacy reasons. This key can increase the fingerprinting surface exposed by CMCD transmission and SHOULD NOT be transmitted in a default player configuration.

  If the playlist declares both peak and average bitrate values, the peak value MUST be transmitted. This top playable bitrate MUST apply to the object type being requested. Requests for video objects MUST specify the top playable video bitrate and requests for audio objects MUST specify the top playable audio bitrate. This value MUST NOT be sent for objects which do not have an object type of ‘a’, ‘v’, ‘av’ or ‘c’.

  Integer Kbps

• Optionalts?: number

  Timestamp (ms since UNIX epoch, required for event mode)

  The timestamp at which the associated event occurred, expressed as milliseconds since the UNIX epoch. When the event is a request for a media object the time SHOULD reference when the request was first initiated. When used with Response Mode, the timestamp should indicate the time at which the object was first requested and not when it was received.

  Integer milliseconds