VideoCustomMetadata (Straas Android SDK 0.24.0 API)

```
public interface VideoCustomMetadata
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BASE_HIT_COUNT` The hit count inherited from related media.
`static String`	`BASE_PLAY_COUNT` The play count inherited from related media.
`static String`	`BASE_PLAY_DURATION` The play duration inherited from related media.
`static String`	`BROADCAST_STARTED_AT` The starting time of the live streaming.
`static String`	`CCU` The live event's number of concurrent users at the last update time.
`static String`	`CCU_UPDATED_AT` The `CCU` last updated time.
`static String`	`CHATROOM_NAME` The chatroom name of the live streaming.
`static String`	`COVER_URL` The image shown in the Straas web player when a live streaming is off air.
`static String`	`CUSTOM_METADATA_ACCOUNT`
`static String`	`CUSTOM_METADATA_IS_LIVE_LOW_LATENCY` Bundle key in `MediaMetadataCompat` to indicate whether the `StraasMediaCore.PLAY_OPTION_LIVE_LOW_LATENCY` bundle key in `MediaControllerCompat.TransportControls.playFromMediaId(String, Bundle)` is set to true or not.
`static String`	`CUSTOM_METADATA_IS_PUBLIC`
`static String`	`HIT_COUNT_SUM` The sum of number of times the media (Live or VOD) hit.
`static String`	`IS_AUDIO_DISABLED` Bundle key in `MediaSessionCompat` extra to indicate whether the audio output is disabled.
`static String`	`KEY_TEXT_TRACKS` Bundle key in `MediaSessionCompat` extra to indicate the subtitle list.
`static String`	`LIVE_BROADCAST_START_TIME` Bundle key for indicate that the broadcast start time of the live event, also means that it is on LIVE now.
`static String`	`LIVE_BROADCAST_STATE_V2` Bundle key in `MediaSessionCompat` extra to indicate the broadcast status of the live event(v2).
`static String`	`LIVE_DVR_ENABLED` Whether to enable live DVR feature for a live event.
`static String`	`LIVE_STATISTICS_CCU` Bundle key in `MediaSessionCompat` extra to indicate the concurrent users of the live event.
`static String`	`LIVE_STATISTICS_HIT_COUNT` Bundle key in `MediaSessionCompat` extra to indicate the media hit count of the live event.
`static String`	`PLAY_COUNT_SUM` The sum of number of times the media (Live or VOD) played.
`static String`	`PLAY_DURATION_SUM` The sum of play duration of the media (Live or VOD) in seconds.
`static String`	`SERVICE_FOREGROUND_IS_ENABLED` Bundle key in `MediaSessionCompat` extra to get the boolean value that indicates the foreground mode is enabled or not.
`static String`	`START_TIME` The start time of the live event.
`static String`	`TEXT_TRACK_ID_ARRAY` The text track ID array for VOD.
`static String`	`TYPE` The event type indicates the live owns different functions and is used in different scenario.
`static String`	`UPDATED_AT` The data last updated time.

- Field Detail
  - CUSTOM_METADATA_ACCOUNT
```
static final String CUSTOM_METADATA_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - CUSTOM_METADATA_IS_PUBLIC
```
static final String CUSTOM_METADATA_IS_PUBLIC
```
    See Also:
    
    Constant Field Values
  - CUSTOM_METADATA_IS_LIVE_LOW_LATENCY
```
static final String CUSTOM_METADATA_IS_LIVE_LOW_LATENCY
```
    Bundle key in MediaMetadataCompat to indicate whether the StraasMediaCore.PLAY_OPTION_LIVE_LOW_LATENCY bundle key in MediaControllerCompat.TransportControls.playFromMediaId(String, Bundle) is set to true or not. Use MediaController.getExtras().getBoolean(CUSTOM_METADATA_IS_LIVE_LOW_LATENCY)
    
    See Also:
    
    StraasMediaCore.PLAY_OPTION_LIVE_LOW_LATENCY, MediaControllerCompat.TransportControls.playFromMediaId(String, Bundle), Constant Field Values
  - PLAY_COUNT_SUM
```
static final String PLAY_COUNT_SUM
```
    The sum of number of times the media (Live or VOD) played. Use MediaController.getExtras().getLong(PLAY_COUNT_SUM)
    
    See Also:
    
    Constant Field Values
  - LIVE_DVR_ENABLED
```
static final String LIVE_DVR_ENABLED
```
    Whether to enable live DVR feature for a live event. Use MediaController.getExtras().getBoolean(LIVE_DVR_ENABLED)
    
    See Also:
    
    Constant Field Values
  - BASE_PLAY_COUNT
```
static final String BASE_PLAY_COUNT
```
    The play count inherited from related media. Use MediaController.getExtras().getLong(BASE_PLAY_COUNT)
    
    See Also:
    
    Constant Field Values
  - PLAY_DURATION_SUM
```
static final String PLAY_DURATION_SUM
```
    The sum of play duration of the media (Live or VOD) in seconds. Use MediaController.getExtras().getLong(PLAY_DURATION_SUM)
    
    See Also:
    
    Constant Field Values
  - BASE_PLAY_DURATION
```
static final String BASE_PLAY_DURATION
```
    The play duration inherited from related media. Use MediaController.getExtras().getLong(BASE_PLAY_DURATION)
    
    See Also:
    
    Constant Field Values
  - HIT_COUNT_SUM
```
static final String HIT_COUNT_SUM
```
    The sum of number of times the media (Live or VOD) hit. Use MediaController.getExtras().getLong(HIT_COUNT_SUM)
    
    See Also:
    
    Constant Field Values
  - BASE_HIT_COUNT
```
static final String BASE_HIT_COUNT
```
    The hit count inherited from related media. Use MediaController.getExtras().getLong(BASE_HIT_COUNT)
    
    See Also:
    
    Constant Field Values
  - UPDATED_AT
```
static final String UPDATED_AT
```
    The data last updated time. Use MediaController.getExtras().getString(UPDATED_AT)
    
    See Also:
    
    Constant Field Values
  - BROADCAST_STARTED_AT
```
static final String BROADCAST_STARTED_AT
```
    The starting time of the live streaming. Use MediaController.getExtras().getString(BROADCAST_STARTED_AT)
    
    See Also:
    
    Constant Field Values
  - START_TIME
```
static final String START_TIME
```
    The start time of the live event. Use MediaController.getExtras().getString(START_TIME)
    
    See Also:
    
    Constant Field Values
  - CHATROOM_NAME
```
static final String CHATROOM_NAME
```
    The chatroom name of the live streaming. Use MediaController.getExtras().getString(CHATROOM_NAME)
    
    See Also:
    
    Constant Field Values
  - CCU
```
static final String CCU
```
    The live event's number of concurrent users at the last update time. Use MediaController.getExtras().getString(CCU)
    
    See Also:
    
    Constant Field Values
  - TYPE
```
static final String TYPE
```
    The event type indicates the live owns different functions and is used in different scenario. {event,sync,channel} Use MediaController.getExtras().getString(TYPE)
    
    See Also:
    
    Constant Field Values
  - CCU_UPDATED_AT
```
static final String CCU_UPDATED_AT
```
    The CCU last updated time. Use MediaController.getExtras().getString(CCU_UPDATED_AT)
    
    See Also:
    
    Constant Field Values
  - COVER_URL
```
static final String COVER_URL
```
    The image shown in the Straas web player when a live streaming is off air. You could upload this image from the live info page in Straas CMS. Use MediaController.getExtras().getString(COVER_URL)
    
    See Also:
    
    Constant Field Values
  - TEXT_TRACK_ID_ARRAY
```
static final String TEXT_TRACK_ID_ARRAY
```
    The text track ID array for VOD. Use MediaController.getExtras().getStringArray(TEXT_TRACK_ID_ARRAY)
    
    See Also:
    
    Constant Field Values
  - IS_AUDIO_DISABLED
```
static final String IS_AUDIO_DISABLED
```
    Bundle key in MediaSessionCompat extra to indicate whether the audio output is disabled. Bundle value is boolean type, the default value is false.
    For client side, use MediaControllerCompat.getExtras() or register callback via MediaControllerCompat.registerCallback(MediaControllerCompat.Callback) to get extras.
    
    See Also:
    
    StraasMediaCore.COMMAND_DISABLE_AUDIO, StraasMediaCore.KEY_DISABLE_AUDIO, Constant Field Values
  - SERVICE_FOREGROUND_IS_ENABLED
```
static final String SERVICE_FOREGROUND_IS_ENABLED
```
    Bundle key in MediaSessionCompat extra to get the boolean value that indicates the foreground mode is enabled or not. If foreground mode is enabled, the Straas MediaBrowserServiceCompat will run in foreground when player state is not PlaybackStateCompat.STATE_PAUSED, PlaybackStateCompat.STATE_STOPPED, or PlaybackStateCompat.STATE_NONE.
    For client side, use MediaControllerCompat.getExtras() or register callback via MediaControllerCompat.registerCallback(MediaControllerCompat.Callback) to get extras.
    
    See Also:
    
    StraasMediaCore.COMMAND_FOREGROUND, StraasMediaCore.COMMAND_STOP_FOREGROUND, Constant Field Values
  - LIVE_BROADCAST_STATE_V2
```
static final String LIVE_BROADCAST_STATE_V2
```
    Bundle key in MediaSessionCompat extra to indicate the broadcast status of the live event(v2). For client side, use MediaControllerCompat.getExtras() or register callback via MediaControllerCompat.registerCallback(MediaControllerCompat.Callback) to get extras.
    The value must be one of the following:
    See Also:
    
    Constant Field Values
  - LIVE_STATISTICS_CCU
```
static final String LIVE_STATISTICS_CCU
```
    Bundle key in MediaSessionCompat extra to indicate the concurrent users of the live event. For client side, use MediaControllerCompat.getExtras() or register callback via registerCallback(...) and listen either onSessionEvent or onExtrasChanged to get real-time value change. Both the event name and the Bundle key is this constant, value is an integer.
    
    See Also:
    
    doc, Constant Field Values
  - LIVE_STATISTICS_HIT_COUNT
```
static final String LIVE_STATISTICS_HIT_COUNT
```
    Bundle key in MediaSessionCompat extra to indicate the media hit count of the live event. For client side, use MediaControllerCompat.getExtras() or register callback via registerCallback(...) and listen either onSessionEvent or onExtrasChanged to get real-time value change. Both the event name and the Bundle key is this constant, value is an integer.
    
    See Also:
    
    doc, Constant Field Values
  - KEY_TEXT_TRACKS
```
static final String KEY_TEXT_TRACKS
```
    Bundle key in MediaSessionCompat extra to indicate the subtitle list. For client side, use MediaControllerCompat.getExtras() or register callback via registerCallback(...) and listen onExtrasChanged to get real-time value change. Both the event name and the Bundle key is this constant, value is string which can convert to subtitle list.
    
    See Also:
    
    Cue, Constant Field Values
  - LIVE_BROADCAST_START_TIME
```
static final String LIVE_BROADCAST_START_TIME
```
    Bundle key for indicate that the broadcast start time of the live event, also means that it is on LIVE now. For client side, use MediaControllerCompat.getExtras() or register callback via MediaControllerCompat.registerCallback(MediaControllerCompat.Callback) to get extras. The value type is Long.
    
    See Also:
    
    LIVE_BROADCAST_STATE_V2, Constant Field Values

Interface VideoCustomMetadata

Field Summary

Field Detail

CUSTOM_METADATA_ACCOUNT

CUSTOM_METADATA_IS_PUBLIC

CUSTOM_METADATA_IS_LIVE_LOW_LATENCY

PLAY_COUNT_SUM

LIVE_DVR_ENABLED

BASE_PLAY_COUNT

PLAY_DURATION_SUM

BASE_PLAY_DURATION

HIT_COUNT_SUM

BASE_HIT_COUNT

UPDATED_AT

BROADCAST_STARTED_AT

START_TIME

CHATROOM_NAME

CCU

TYPE

CCU_UPDATED_AT

COVER_URL

TEXT_TRACK_ID_ARRAY

IS_AUDIO_DISABLED

SERVICE_FOREGROUND_IS_ENABLED

LIVE_BROADCAST_STATE_V2

LIVE_STATISTICS_CCU

LIVE_STATISTICS_HIT_COUNT

KEY_TEXT_TRACKS

LIVE_BROADCAST_START_TIME