StraasMediaCore (Straas Android SDK 0.24.0 API)

java.lang.Object
- io.straas.android.sdk.media.StraasMediaCore

```
public final class StraasMediaCore
extends Object
```
The core which will create a MediaBrowserCompat for you to connect to the Straas MediaBrowserServiceCompat, also handles the video and ad rendering layers.
Don't forget to fill the SDK credential and the member Identity.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StraasMediaCore.DisplayMode`
`static class`	`StraasMediaCore.ErrorReason`
`static class`	`StraasMediaCore.ImaHelperBase`
`static class`	`StraasMediaCore.MediaCoreConfig` Configuration for the `StraasMediaCore`
`static interface`	`StraasMediaCore.PlaneProjectionMode`
`static interface`	`StraasMediaCore.UiContainer`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AD_PLAYBACK_ID` One of the id in `PlaybackStateCompat.getActiveQueueItemId()`, means it is playing an ad now.
`static String`	`COMMAND_DISABLE_AUDIO` Command to disable/re-enable audio output immediately and all future media playback.
`static String`	`COMMAND_FOREGROUND` Enable foreground flag, this will make the Straas `MediaBrowserServiceCompat` run in foreground when player state is not `PlaybackStateCompat.STATE_PAUSED`, `PlaybackStateCompat.STATE_STOPPED`, or `PlaybackStateCompat.STATE_NONE`.
`static String`	`COMMAND_GET_LOCATION` Command to get the current `Location` which is set by `COMMAND_SET_LOCATION`.
`static String`	`COMMAND_GET_PLAYBACK_SPEED` Command for getting playback speed.
`static String`	`COMMAND_GET_VIDEO_FORMATS` Command for getting all video tracks formats.
`static String`	`COMMAND_PLAY_AT_LIVE_EDGE` Command to seek the current playback position to the real-time coverage of live (live edge) and play automatically.
`static String`	`COMMAND_PLAYER_RETRY` Command to try again to play the last played media.
`static String`	`COMMAND_SET_FORMAT_INDEX` Action command for set new video format index.
`static String`	`COMMAND_SET_LOCATION` Action command to set the location information when a Straas media is playing.
`static String`	`COMMAND_SET_PLAYBACK_SPEED` Action command for set playback speed.
`static String`	`COMMAND_STOP_FOREGROUND` Remove the Straas `MediaBrowserServiceCompat` from foreground state and clear the `Notification`.
`static int`	`DISPLAY_MODE_CARDBOARD` video frame is divided into two windows for left and right eye respectively, useful when user put device into cardboard.
`static int`	`DISPLAY_MODE_NORMAL` video frame window is displayed normally.
`static String`	`DRM_KEY_REQUEST_PROPERTIES`
`static String`	`DRM_LICENSE_URL`
`static String`	`DRM_SCHEME_UUID_EXTRA`
`static String`	`EVENT_MEDIA_BROWSER_SERVICE_ERROR`
`static String`	`EVENT_PLAYER_ERROR_MESSAGE`
`static String`	`EVENT_TYPE`
`static String`	`EXTRA_CONTENT_TYPE` Extra Bundle key only if you want to use `playFromUri` to play content outside of Straas server storage without explicit filename extension (e.g. .mp4, .m3u8).
`static String`	`EXTRA_IS_AUDIO_DISABLED` Deprecated. use `VideoCustomMetadata.IS_AUDIO_DISABLED` instead
`static String`	`EXTRA_SERVICE_FOREGROUND_IS_ENABLED` Deprecated. use `VideoCustomMetadata.SERVICE_FOREGROUND_IS_ENABLED` instead
`static String`	`EXTRA_TEXT_TRACKS_INFO` Extra Bundle key .
`static String`	`ITEM_ID_PLAYLIST_PREFIX` Item id prefix to query a playlist info using `getItem`.
`static String`	`KEY_ALL_VIDEO_FORMATS` Bundle key in the result of `ResultReceiver.onReceiveResult(int, Bundle)` to get all video tracks formats.
`static String`	`KEY_CURRENT_PLAYBACK_SPEED` Bundle key in the result of `ResultReceiver.onReceiveResult(int, Bundle)` to get and set playback speed.
`static String`	`KEY_CURRENT_VIDEO_FORMAT_INDEX` Use this Bundle key to get and set current format index.
`static String`	`KEY_DISABLE_AUDIO` Use this Bundle key to set whether the audio output should be disabled or not to the Straas `MediaBrowserServiceCompat`.
`static String`	`KEY_EXTRA_TEXT_TRACKS` Deprecated. use `VideoCustomMetadata.KEY_TEXT_TRACKS` instead
`static String`	`KEY_LOCATION` The Bundle key to set or get the `Location`.
`static String`	`KEY_MEDIA_BROWSER_ERROR_MESSAGE`
`static String`	`KEY_MEDIA_BROWSER_ERROR_REASON`
`static String`	`KEY_NOTIFICATION_OPTIONS` Use this Bundle key to set a `NotificationOptions` to the Straas `MediaBrowserServiceCompat`.
`static String`	`KEY_PAGE_TOKEN` Bundle key we put in the last `MediaBrowserCompat.MediaItem` of a list to indicate what next parent id is.
`static String`	`KEY_VIDEO_RENDER_TYPE` Extra Bundle key only if you want to use `playFromUri` to play content outside of Straas server storage and want to control different render type.
`static String`	`LIVE_EXTRA_BROADCAST_START_TIME` Deprecated. use `VideoCustomMetadata.LIVE_BROADCAST_START_TIME` instead
`static String`	`LIVE_EXTRA_BROADCAST_STATE` Deprecated. use `VideoCustomMetadata.LIVE_BROADCAST_STATE_V2` instead
`static String`	`LIVE_EXTRA_BROADCAST_STATE_LIVE` Bundle value for indicate that the broadcast status of the live event is on LIVE now.
`static String`	`LIVE_EXTRA_BROADCAST_STATE_V2` Deprecated. use `VideoCustomMetadata.LIVE_BROADCAST_STATE_V2` instead
`static String`	`LIVE_EXTRA_BROADCAST_STATE_WAIT_STREAM` Bundle value for indicate that the live event meets a trouble now, our server is waiting for the streaming.
`static String`	`LIVE_EXTRA_CURRENT_DATE_TIME` Bundle key in `PlaybackStateCompat` extra to indicate the current live date time from HLS EXT-X-PROGRAM-DATE-TIME tag.
`static String`	`LIVE_EXTRA_EVENT_STATE` Deprecated. use `VideoCustomMetadata.LIVE_BROADCAST_STATE_V2` instead
`static String`	`LIVE_EXTRA_EVENT_STATE_ENDED` Bundle value for indicate that the live event is ended.
`static String`	`LIVE_EXTRA_EVENT_STATE_READY` Bundle value for indicate that the live event is ready to broadcast.
`static String`	`LIVE_EXTRA_EVENT_STATE_STARTED` Bundle value for indicate that the live event is on LIVE now, while the the broadcast status may be `LIVE_EXTRA_BROADCAST_STATE_LIVE` or `LIVE_EXTRA_BROADCAST_STATE_WAIT_STREAM`.
`static String`	`LIVE_EXTRA_STATISTICS_CCU` Deprecated. use `VideoCustomMetadata.LIVE_STATISTICS_CCU` instead
`static String`	`LIVE_EXTRA_STATISTICS_HIT_COUNT` Deprecated.
`static String`	`LIVE_ID_PREFIX` Item id prefix to query or play a live event info.
`static String`	`PARENT_ID_LIVES` Parent id to subscribe all available public live event list.
`static String`	`PARENT_ID_VODS` Parent id to subscribe all available public VOD (video on demand) list.
`static int`	`PLANE_PROJECTION_MODE_CROP` video frame is scaled to fill the size of the view by maintaining the aspect ratio.
`static int`	`PLANE_PROJECTION_MODE_FIT` video frame is scaled to fit the size of the view by maintaining the aspect ratio (black borders may be displayed).
`static int`	`PLANE_PROJECTION_MODE_FULL` The specified aspect ratio is ignored.
`static String`	`PLAY_OPTION_HLS_LIVE_SYNC_INTERVAL_COUNT` Extra Bundle key in `playFromMediaId`.
`static String`	`PLAY_OPTION_LIVE_LOW_LATENCY` Extra Bundle key in `playFromMediaId` which could significantly reduce the latency between broadcaster and viewers if set the Bundle value to true, but the adaptive bitrate will be disabled.
`static String`	`PLAY_OPTION_SEEK_TIME` Extra Bundle key only if you need to seek to the specific timestamp at start.
`static String`	`SUBSCRIBE_CHILDREN_OPTIONS_CATEGORY_IDS` Bundle key when `subscribing` to a parent id with an optional Bundle.
`static String`	`SUBSCRIBE_CHILDREN_OPTIONS_OWNER_MEMBER_ID` Bundle key when `subscribing` to a parent id with an optional Bundle.
`static String`	`SUBSCRIBE_CHILDREN_OPTIONS_SORT` Bundle key when `subscribing` to a parent id with an optional Bundle.
`static String`	`SUBSCRIBE_CHILDREN_OPTIONS_STATUS` Bundle key when `subscribing` to a parent id with an optional Bundle.
`static String`	`SUBSCRIBE_CHILDREN_OPTIONS_TYPES` Bundle key when `subscribing` to a parent id with an optional Bundle.
`static int`	`VIDEO_RENDER_TYPE_360`
`static int`	`VIDEO_RENDER_TYPE_NONE`
`static int`	`VIDEO_RENDER_TYPE_PLAIN`

Constructor Summary

Constructors
Constructor and Description
`StraasMediaCore(Identity identity, MediaBrowserCompat.ConnectionCallback callback)` Create a `MediaBrowserCompat` which could get through `getMediaBrowser()`.
`StraasMediaCore(StraasMediaCore.MediaCoreConfig config)` Create a `MediaBrowserCompat` which could get through `getMediaBrowser()`.
`StraasMediaCore(StraasMediaCore.UiContainer uiContainer, Identity identity, MediaBrowserCompat.ConnectionCallback callback)` Create a `MediaBrowserCompat` which could get through `getMediaBrowser()`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getDisplayMode()`
`MediaBrowserCompat`	`getMediaBrowser()` This instance reference MAY change any time, DO-NOT keep this reference.
`MediaControllerCompat`	`getMediaController()`
`int`	`getPlaneProjectionMode()`
`void`	`setDisplayMode(int displayMode)` Set how video frame window is displayed.
`void`	`setIdentity(Identity identity)` Set a new identity after MediaBrowser is connected.
`StraasMediaCore`	`setImaHelper(StraasMediaCore.ImaHelperBase imaHelper)` Optional API only if you need Interactive Media Ad integration.
`void`	`setPlaneProjectionMode(int planeProjectionMode)` Set projection mode when render type is `VIDEO_RENDER_TYPE_PLAIN` which is a plain instead of sphere.
`StraasMediaCore`	`setUiContainer(StraasMediaCore.UiContainer uiContainer)` Optional API only if you didn't put it at constructor, or you want to change the container target.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_ALL_VIDEO_FORMATS
```
public static final String KEY_ALL_VIDEO_FORMATS
```
    Bundle key in the result of ResultReceiver.onReceiveResult(int, Bundle) to get all video tracks formats.
    
    See Also:
    
    COMMAND_GET_VIDEO_FORMATS, KEY_CURRENT_VIDEO_FORMAT_INDEX, MediaControllerCompat.sendCommand(String, Bundle, ResultReceiver), Format, Constant Field Values
  - KEY_CURRENT_VIDEO_FORMAT_INDEX
```
public static final String KEY_CURRENT_VIDEO_FORMAT_INDEX
```
    Use this Bundle key to get and set current format index.
    
    See Also:
    
    COMMAND_GET_VIDEO_FORMATS, KEY_ALL_VIDEO_FORMATS, MediaControllerCompat.sendCommand(String, Bundle, ResultReceiver), MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), Constant Field Values
  - COMMAND_SET_FORMAT_INDEX
```
public static final String COMMAND_SET_FORMAT_INDEX
```
    Action command for set new video format index.
    
    See Also:
    
    KEY_CURRENT_VIDEO_FORMAT_INDEX, MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), Constant Field Values
  - COMMAND_GET_VIDEO_FORMATS
```
public static final String COMMAND_GET_VIDEO_FORMATS
```
    Command for getting all video tracks formats. Below is an example for query all formats as list and which index is selected currently.
```
 public static void getVideoQualityInfo(MediaControllerCompat controller) {
     controller.sendCommand(COMMAND_GET_VIDEO_FORMATS, null,
         new ResultReceiver(new Handler()) {
             @Override
             protected void onReceiveResult(int resultCode, Bundle resultData) {
                 resultData.setClassLoader(Format.class.getClassLoader());
                 if (resultData.containsKey(KEY_CURRENT_VIDEO_FORMAT_INDEX)) {
                     // all video tracks formats
                     ArrayList<Format> formats = resultData
                        .getParcelableArrayList(KEY_ALL_VIDEO_FORMATS);
                     // current format index of formats
                     int selectedIndex = resultData.getInt(KEY_CURRENT_VIDEO_FORMAT_INDEX);
                 }
             }
         });
 }
 
```
    See Also:
    
    KEY_ALL_VIDEO_FORMATS, KEY_CURRENT_VIDEO_FORMAT_INDEX, Constant Field Values
  - KEY_CURRENT_PLAYBACK_SPEED
```
public static final String KEY_CURRENT_PLAYBACK_SPEED
```
    Bundle key in the result of ResultReceiver.onReceiveResult(int, Bundle) to get and set playback speed.
    
    See Also:
    
    COMMAND_GET_PLAYBACK_SPEED, COMMAND_SET_PLAYBACK_SPEED, MediaControllerCompat.sendCommand(String, Bundle, ResultReceiver), MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), Constant Field Values
  - COMMAND_GET_PLAYBACK_SPEED
```
public static final String COMMAND_GET_PLAYBACK_SPEED
```
    Command for getting playback speed.
    
    See Also:
    
    KEY_CURRENT_PLAYBACK_SPEED, MediaControllerCompat.sendCommand(String, Bundle, ResultReceiver), Constant Field Values
  - COMMAND_SET_PLAYBACK_SPEED
```
public static final String COMMAND_SET_PLAYBACK_SPEED
```
    Action command for set playback speed.
    
    See Also:
    
    KEY_CURRENT_PLAYBACK_SPEED, MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), Constant Field Values
  - KEY_NOTIFICATION_OPTIONS
```
public static final String KEY_NOTIFICATION_OPTIONS
```
    Use this Bundle key to set a NotificationOptions to the Straas MediaBrowserServiceCompat.
    
    See Also:
    
    COMMAND_FOREGROUND, MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), Constant Field Values
  - COMMAND_FOREGROUND
```
public static final String COMMAND_FOREGROUND
```
    Enable foreground flag, this will make the Straas MediaBrowserServiceCompat run in foreground when player state is not PlaybackStateCompat.STATE_PAUSED, PlaybackStateCompat.STATE_STOPPED, or PlaybackStateCompat.STATE_NONE. You can use KEY_NOTIFICATION_OPTIONS and NotificationOptions to set some options of the Notification.
    
    See Also:
    
    Service.startForeground(int, Notification), MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), KEY_NOTIFICATION_OPTIONS, VideoCustomMetadata.SERVICE_FOREGROUND_IS_ENABLED, Constant Field Values
  - COMMAND_STOP_FOREGROUND
```
public static final String COMMAND_STOP_FOREGROUND
```
    Remove the Straas MediaBrowserServiceCompat from foreground state and clear the Notification.
    
    See Also:
    
    Service.stopForeground(boolean), MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), VideoCustomMetadata.SERVICE_FOREGROUND_IS_ENABLED, Constant Field Values
  - COMMAND_DISABLE_AUDIO
```
public static final String COMMAND_DISABLE_AUDIO
```
    Command to disable/re-enable audio output immediately and all future media playback.
    There are some important things you should notice when using this command:
    - When developer disable the audio output during playback, previously obtained audio focus will be abandoned internally.
    - Re-enable the audio output during playback will be accompanied by a successful audio focus request internally.
    - If developer makes the Straas MediaBrowserServiceCompat run in foreground by using COMMAND_FOREGROUND while the audio output is disabled, we will force re-enable the audio output.
    - Disable the audio output during the Straas MediaBrowserServiceCompat runs in foreground will be no-op. A warning message will show up in the logcat instead.
```
 public static void disableAudio(MediaControllerCompat controller, boolean disable) {
        Bundle bundle = new Bundle();
        bundle.putBoolean(KEY_DISABLE_AUDIO, disable);
        controller.getTransportControls().sendCustomAction(COMMAND_DISABLE_AUDIO, bundle);
 }
 
```
    See Also:
    
    VideoCustomMetadata.IS_AUDIO_DISABLED, KEY_DISABLE_AUDIO, Constant Field Values
  - COMMAND_PLAY_AT_LIVE_EDGE
```
public static final String COMMAND_PLAY_AT_LIVE_EDGE
```
    Command to seek the current playback position to the real-time coverage of live (live edge) and play automatically.
    This command won't work under the following conditions:
    - If the current playing media is not a live
    - If VideoCustomMetadata.LIVE_DVR_ENABLED is false
    - If VideoCustomMetadata.CUSTOM_METADATA_IS_LIVE_LOW_LATENCY is true
    See Also:
    
    MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), Constant Field Values
  - COMMAND_PLAYER_RETRY
```
public static final String COMMAND_PLAYER_RETRY
```
    Command to try again to play the last played media. This command only works after an error occurs.
    NOTE: This command is in BETA stage and might be deprecated in the later version.
    
    See Also:
    
    MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), Constant Field Values
  - COMMAND_SET_LOCATION
```
public static final String COMMAND_SET_LOCATION
```
    Action command to set the location information when a Straas media is playing. The logged data could be downloaded later via CMS API. You could disable this function by not setting location information or setting null as the location information. Use KEY_LOCATION as the Bundle key to set the Location.
    
    See Also:
    
    MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), COMMAND_GET_LOCATION, KEY_LOCATION, Constant Field Values
  - COMMAND_GET_LOCATION
```
public static final String COMMAND_GET_LOCATION
```
    Command to get the current Location which is set by COMMAND_SET_LOCATION. Use KEY_LOCATION as the Bundle key to get the Location.
    
    See Also:
    
    MediaControllerCompat.sendCommand(String, Bundle, ResultReceiver), COMMAND_SET_LOCATION, KEY_LOCATION, Constant Field Values
  - KEY_LOCATION
```
public static final String KEY_LOCATION
```
    The Bundle key to set or get the Location. Only latitude and longitude will be logged for now. These two values will be rounded down to eighth decimal place.
    
    See Also:
    
    BaseBundle.get(String), COMMAND_SET_LOCATION, COMMAND_GET_LOCATION, Constant Field Values
  - EXTRA_IS_AUDIO_DISABLED
```
@Deprecated
public static final String EXTRA_IS_AUDIO_DISABLED
```
    Deprecated. use VideoCustomMetadata.IS_AUDIO_DISABLED instead
    
    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(Callback) to get extras.
    
    See Also:
    
    COMMAND_DISABLE_AUDIO, KEY_DISABLE_AUDIO, Constant Field Values
  - KEY_DISABLE_AUDIO
```
public static final String KEY_DISABLE_AUDIO
```
    Use this Bundle key to set whether the audio output should be disabled or not to the Straas MediaBrowserServiceCompat. Bundle value is boolean type, true means the audio output will be disabled.
    
    See Also:
    
    COMMAND_DISABLE_AUDIO, MediaControllerCompat.TransportControls.sendCustomAction(String, Bundle), VideoCustomMetadata.IS_AUDIO_DISABLED, Constant Field Values
  - EXTRA_SERVICE_FOREGROUND_IS_ENABLED
```
@Deprecated
public static final String EXTRA_SERVICE_FOREGROUND_IS_ENABLED
```
    Deprecated. use VideoCustomMetadata.SERVICE_FOREGROUND_IS_ENABLED instead
    
    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(Callback) to get extras.
    
    See Also:
    
    COMMAND_FOREGROUND, COMMAND_STOP_FOREGROUND, Constant Field Values
  - EXTRA_CONTENT_TYPE
```
public static final String EXTRA_CONTENT_TYPE
```
    Extra Bundle key only if you want to use playFromUri to play content outside of Straas server storage without explicit filename extension (e.g. *.mp4, *.m3u8).
    The content type value mapping is the same as ExoPlayer:
```
  public static void playContentType(MediaControllerCompat controller, Uri uri, int type) {
      Bundle bundle = new Bundle();
      switch (type) {
          case C.TYPE_HLS:
          case C.TYPE_DASH:
          case C.TYPE_SS:
          case C.TYPE_OTHER:
              bundle.putInt(EXTRA_CONTENT_TYPE, type);
              break;
          default:
              throw new IllegalArgumentException("Must be one of TYPE_HLS, TYPE_DASH, TYPE_SS, TYPE_OTHER");
      }
      controller.getTransportControls().playFromUri(uri, bundle);
  }
 
```
    See Also:
    
    MediaControllerCompat.TransportControls.playFromUri(Uri, Bundle), C.TYPE_DASH, C.TYPE_HLS, C.TYPE_SS, C.TYPE_OTHER, Constant Field Values
  - EXTRA_TEXT_TRACKS_INFO
```
public static final String EXTRA_TEXT_TRACKS_INFO
```
    Extra Bundle key .
    
    See Also:
    
    MediaControllerCompat.TransportControls.playFromUri(Uri, Bundle), Constant Field Values
  - KEY_PAGE_TOKEN
```
public static final String KEY_PAGE_TOKEN
```
    Bundle key we put in the last MediaBrowserCompat.MediaItem of a list to indicate what next parent id is. Use the value to subscribe and you will get the next page content.
```
 public static String extractPageToken(@NonNull List<MediaItem> items) {
     return items.get(items.size() - 1)
             .getDescription().getExtras().getString(KEY_PAGE_TOKEN);
 }

 public void onLoadMore() {
     String pageToken = extractPageToken(mAdapter.getMediaItems());
     if (!TextUtils.isEmpty(pageToken)) {
         getMediaBrowser().subscribe(pageToken, mSubscriptionCallback);
     }
 }
 
```
    See Also:
    
    Constant Field Values
  - PLAY_OPTION_SEEK_TIME
```
public static final String PLAY_OPTION_SEEK_TIME
```
    Extra Bundle key only if you need to seek to the specific timestamp at start.
    During the playback you could use MediaControllerCompat.TransportControls.seekTo(long).
```
  public static void playAndSeekFromMediaId(MediaControllerCompat controller, String mediaId, long positionMs) {
      Bundle bundle = new Bundle();
      bundle.putLong(PLAY_OPTION_SEEK_TIME, positionMs);
      controller.getTransportControls().playFromMediaId(mediaId, bundle);
  }
 
```
    See Also:
    
    Constant Field Values
  - PLAY_OPTION_LIVE_LOW_LATENCY
```
public static final String PLAY_OPTION_LIVE_LOW_LATENCY
```
    Extra Bundle key in playFromMediaId which could significantly reduce the latency between broadcaster and viewers if set the Bundle value to true, but the adaptive bitrate will be disabled.
    
    See Also:
    
    Constant Field Values
  - PLAY_OPTION_HLS_LIVE_SYNC_INTERVAL_COUNT
```
public static final String PLAY_OPTION_HLS_LIVE_SYNC_INTERVAL_COUNT
```
    Extra Bundle key in playFromMediaId. The value type is int. It decides which ts file in a m3u8 of HLS spec to play in the beginning. The value 0 means to play the latest ts file, and the value 3 means to play the 3rd one. You can only set this to 2 or 3, and the default value is 3. This only works when the media type is live and the Bundle value of PLAY_OPTION_LIVE_LOW_LATENCY is false.
    
    See Also:
    
    Constant Field Values
  - AD_PLAYBACK_ID
```
public static final int AD_PLAYBACK_ID
```
    One of the id in PlaybackStateCompat.getActiveQueueItemId(), means it is playing an ad now.
    
    See Also:
    
    Constant Field Values
  - EVENT_TYPE
```
public static final String EVENT_TYPE
```
    See Also:
    
    Constant Field Values
  - EVENT_PLAYER_ERROR_MESSAGE
```
public static final String EVENT_PLAYER_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - EVENT_MEDIA_BROWSER_SERVICE_ERROR
```
public static final String EVENT_MEDIA_BROWSER_SERVICE_ERROR
```
    See Also:
    
    Constant Field Values
  - KEY_MEDIA_BROWSER_ERROR_REASON
```
public static final String KEY_MEDIA_BROWSER_ERROR_REASON
```
    See Also:
    
    Constant Field Values
  - KEY_MEDIA_BROWSER_ERROR_MESSAGE
```
public static final String KEY_MEDIA_BROWSER_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - KEY_VIDEO_RENDER_TYPE
```
public static final String KEY_VIDEO_RENDER_TYPE
```
    Extra Bundle key only if you want to use playFromUri to play content outside of Straas server storage and want to control different render type.
```
  public static void playWithRenderType(MediaControllerCompat controller, Uri uri, int type) {
      Bundle bundle = new Bundle();
      switch (type) {
          case VIDEO_RENDER_TYPE_360:
          case VIDEO_RENDER_TYPE_PLAIN:
              bundle.putInt(KEY_VIDEO_RENDER_TYPE, type);
              break;
          default:
              bundle.putInt(KEY_VIDEO_RENDER_TYPE, VIDEO_RENDER_TYPE_PLAIN);
              break;
      }
      controller.getTransportControls().playFromUri(uri, bundle);
  }
 
```
    See Also:
    
    MediaControllerCompat.TransportControls.playFromUri(Uri, Bundle), VIDEO_RENDER_TYPE_360, VIDEO_RENDER_TYPE_PLAIN, Constant Field Values
  - VIDEO_RENDER_TYPE_NONE
```
public static final int VIDEO_RENDER_TYPE_NONE
```
    See Also:
    
    KEY_VIDEO_RENDER_TYPE, Constant Field Values
  - VIDEO_RENDER_TYPE_PLAIN
```
public static final int VIDEO_RENDER_TYPE_PLAIN
```
    See Also:
    
    KEY_VIDEO_RENDER_TYPE, VIDEO_RENDER_TYPE_360, Constant Field Values
  - VIDEO_RENDER_TYPE_360
```
public static final int VIDEO_RENDER_TYPE_360
```
    See Also:
    
    KEY_VIDEO_RENDER_TYPE, VIDEO_RENDER_TYPE_PLAIN, Constant Field Values
  - ITEM_ID_PLAYLIST_PREFIX
```
public static final String ITEM_ID_PLAYLIST_PREFIX
```
    Item id prefix to query a playlist info using getItem.
    
    See Also:
    
    Constant Field Values
  - LIVE_ID_PREFIX
```
public static final String LIVE_ID_PREFIX
```
    Item id prefix to query or play a live event info.
    
    See Also:
    
    MediaBrowserCompat.getItem(String, MediaBrowserCompat.ItemCallback), MediaControllerCompat.TransportControls.playFromMediaId(String, Bundle), Constant Field Values
  - PARENT_ID_LIVES
```
public static final String PARENT_ID_LIVES
```
    Parent id to subscribe all available public live event list. You could get broadcastStateV2 by using the extra bundle in MediaBrowserCompat.MediaItem.getDescription() with VideoCustomMetadata.LIVE_BROADCAST_STATE_V2 key. If you subscribe live event list without given sort option, the default sorting type will be "-start_time".
    
    See Also:
    
    MediaBrowserCompat.subscribe(String, MediaBrowserCompat.SubscriptionCallback), SUBSCRIBE_CHILDREN_OPTIONS_SORT, Constant Field Values
  - PARENT_ID_VODS
```
public static final String PARENT_ID_VODS
```
    Parent id to subscribe all available public VOD (video on demand) list. If you subscribe VOD list without given sort option, the default sorting type will be "-created_at".
    
    See Also:
    
    MediaBrowserCompat.subscribe(String, Bundle, MediaBrowserCompat.SubscriptionCallback), SUBSCRIBE_CHILDREN_OPTIONS_SORT, Constant Field Values
  - SUBSCRIBE_CHILDREN_OPTIONS_SORT
```
public static final String SUBSCRIBE_CHILDREN_OPTIONS_SORT
```
    Bundle key when subscribing to a parent id with an optional Bundle. You must use putString to set the sorting type depends on what kinds of parent id you want to subscribe. This value denote how to sort the children list data.
    e.g. "-created_at"
    
    See Also:
    
    VOD list, Live list, Constant Field Values
  - SUBSCRIBE_CHILDREN_OPTIONS_OWNER_MEMBER_ID
```
public static final String SUBSCRIBE_CHILDREN_OPTIONS_OWNER_MEMBER_ID
```
    Bundle key when subscribing to a parent id with an optional Bundle. You must use putString to set the owner member id filter to query partial children list data belonging to the specific owner only.
    Empty value denotes disabling this filter.
    
    See Also:
    
    VOD list, Live list, Constant Field Values
  - SUBSCRIBE_CHILDREN_OPTIONS_CATEGORY_IDS
```
public static final String SUBSCRIBE_CHILDREN_OPTIONS_CATEGORY_IDS
```
    Bundle key when subscribing to a parent id with an optional Bundle. You must use putString to set the category ids filter to query partial children list data belonging to the specific categories.
    Empty value denotes disabling this filter.
    e.g. "1,3,5"
    
    See Also:
    
    VOD list, Live list, Constant Field Values
  - SUBSCRIBE_CHILDREN_OPTIONS_TYPES
```
public static final String SUBSCRIBE_CHILDREN_OPTIONS_TYPES
```
    Bundle key when subscribing to a parent id with an optional Bundle. You must use putString to set the types filter to query partial live list data belonging to the specific types.
    Empty value denotes disabling this filter.
    This option is only for live events.
    e.g. "event,channel" for live event
    
    See Also:
    
    Live list, Constant Field Values
  - SUBSCRIBE_CHILDREN_OPTIONS_STATUS
```
public static final String SUBSCRIBE_CHILDREN_OPTIONS_STATUS
```
    Bundle key when subscribing to a parent id with an optional Bundle. You must use putString to set the status filter to query partial live list data belonging to the specific status.
    Empty value denotes disabling this filter.
    This option is only for live events.
    e.g. "ready,ended"
    
    See Also:
    
    Live list, Constant Field Values
  - LIVE_EXTRA_BROADCAST_START_TIME
```
@Deprecated
public static final String LIVE_EXTRA_BROADCAST_START_TIME
```
    Deprecated. use VideoCustomMetadata.LIVE_BROADCAST_START_TIME instead
    
    Bundle key for indicate that the broadcast start time of the live event, also means that it is on LIVE now.
    
    See Also:
    
    LIVE_EXTRA_BROADCAST_STATE, Constant Field Values
  - LIVE_EXTRA_BROADCAST_STATE
```
@Deprecated
public static final String LIVE_EXTRA_BROADCAST_STATE
```
    Deprecated. use VideoCustomMetadata.LIVE_BROADCAST_STATE_V2 instead
    
    Bundle key in MediaSessionCompat extra to indicate the broadcast status of the live event. For client side, use MediaControllerCompat.getExtras() or register callback via MediaControllerCompat.registerCallback(Callback) to get extras.
    If extra Bundle don't have this key, of the value is empty, means that the live event is offline, otherwise, the value will be either LIVE_EXTRA_BROADCAST_STATE_LIVE or LIVE_EXTRA_BROADCAST_STATE_WAIT_STREAM.
    
    See Also:
    
    Constant Field Values
  - LIVE_EXTRA_BROADCAST_STATE_V2
```
@Deprecated
public static final String LIVE_EXTRA_BROADCAST_STATE_V2
```
    Deprecated. use VideoCustomMetadata.LIVE_BROADCAST_STATE_V2 instead
    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(Callback) to get extras.
    The value must be one of the following:
    See Also:
    
    Constant Field Values
  - LIVE_EXTRA_BROADCAST_STATE_LIVE
```
public static final String LIVE_EXTRA_BROADCAST_STATE_LIVE
```
    Bundle value for indicate that the broadcast status of the live event is on LIVE now.
    
    See Also:
    
    LIVE_EXTRA_BROADCAST_STATE, LIVE_EXTRA_BROADCAST_STATE_WAIT_STREAM, LIVE_EXTRA_BROADCAST_START_TIME, Constant Field Values
  - LIVE_EXTRA_BROADCAST_STATE_WAIT_STREAM
```
public static final String LIVE_EXTRA_BROADCAST_STATE_WAIT_STREAM
```
    Bundle value for indicate that the live event meets a trouble now, our server is waiting for the streaming. The future state may be LIVE_EXTRA_BROADCAST_STATE_LIVE or offline.
    
    See Also:
    
    LIVE_EXTRA_BROADCAST_STATE, LIVE_EXTRA_BROADCAST_STATE_LIVE, LIVE_EXTRA_BROADCAST_START_TIME, Constant Field Values
  - LIVE_EXTRA_EVENT_STATE
```
@Deprecated
public static final String LIVE_EXTRA_EVENT_STATE
```
    Deprecated. use VideoCustomMetadata.LIVE_BROADCAST_STATE_V2 instead
    Bundle key for indicate that an live event status. For client side, use MediaControllerCompat.getExtras() or register callback via MediaControllerCompat.registerCallback(Callback) to get extras.
    The state value must be one of the following:
    See Also:
    
    Constant Field Values
  - LIVE_EXTRA_EVENT_STATE_ENDED
```
public static final String LIVE_EXTRA_EVENT_STATE_ENDED
```
    Bundle value for indicate that the live event is ended.
    
    See Also:
    
    LIVE_EXTRA_EVENT_STATE, LIVE_EXTRA_EVENT_STATE_READY, LIVE_EXTRA_EVENT_STATE_STARTED, Constant Field Values
  - LIVE_EXTRA_EVENT_STATE_READY
```
public static final String LIVE_EXTRA_EVENT_STATE_READY
```
    Bundle value for indicate that the live event is ready to broadcast.
    
    See Also:
    
    LIVE_EXTRA_EVENT_STATE, LIVE_EXTRA_EVENT_STATE_ENDED, LIVE_EXTRA_EVENT_STATE_STARTED, Constant Field Values
  - LIVE_EXTRA_EVENT_STATE_STARTED
```
public static final String LIVE_EXTRA_EVENT_STATE_STARTED
```
    Bundle value for indicate that the live event is on LIVE now, while the the broadcast status may be LIVE_EXTRA_BROADCAST_STATE_LIVE or LIVE_EXTRA_BROADCAST_STATE_WAIT_STREAM.
    
    See Also:
    
    LIVE_EXTRA_EVENT_STATE, LIVE_EXTRA_EVENT_STATE_READY, LIVE_EXTRA_EVENT_STATE_ENDED, Constant Field Values
  - LIVE_EXTRA_STATISTICS_CCU
```
@Deprecated
public static final String LIVE_EXTRA_STATISTICS_CCU
```
    Deprecated. use VideoCustomMetadata.LIVE_STATISTICS_CCU instead
    
    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_EXTRA_STATISTICS_HIT_COUNT
```
@Deprecated
public static final String LIVE_EXTRA_STATISTICS_HIT_COUNT
```
    Deprecated.
    
    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_EXTRA_TEXT_TRACKS
```
@Deprecated
public static final String KEY_EXTRA_TEXT_TRACKS
```
    Deprecated. use VideoCustomMetadata.KEY_TEXT_TRACKS instead
    
    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_EXTRA_CURRENT_DATE_TIME
```
public static final String LIVE_EXTRA_CURRENT_DATE_TIME
```
    Bundle key in PlaybackStateCompat extra to indicate the current live date time from HLS EXT-X-PROGRAM-DATE-TIME tag. For client side, use PlaybackStateCompat.getExtras() to inference live date time according to current position.
    
    See Also:
    
    Constant Field Values
  - DRM_SCHEME_UUID_EXTRA
```
public static final String DRM_SCHEME_UUID_EXTRA
```
    See Also:
    
    HttpMediaDrmCallback, Constant Field Values
  - DRM_LICENSE_URL
```
public static final String DRM_LICENSE_URL
```
    See Also:
    
    HttpMediaDrmCallback, Constant Field Values
  - DRM_KEY_REQUEST_PROPERTIES
```
public static final String DRM_KEY_REQUEST_PROPERTIES
```
    See Also:
    
    HttpMediaDrmCallback, Constant Field Values
  - DISPLAY_MODE_NORMAL
```
public static final int DISPLAY_MODE_NORMAL
```
    video frame window is displayed normally.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_MODE_CARDBOARD
```
public static final int DISPLAY_MODE_CARDBOARD
```
    video frame is divided into two windows for left and right eye respectively, useful when user put device into cardboard.
    
    See Also:
    
    Constant Field Values
  - PLANE_PROJECTION_MODE_FIT
```
public static final int PLANE_PROJECTION_MODE_FIT
```
    video frame is scaled to fit the size of the view by maintaining the aspect ratio (black borders may be displayed).
    
    See Also:
    
    Constant Field Values
  - PLANE_PROJECTION_MODE_CROP
```
public static final int PLANE_PROJECTION_MODE_CROP
```
    video frame is scaled to fill the size of the view by maintaining the aspect ratio. Some portion of the video frame may be clipped.
    
    See Also:
    
    Constant Field Values
  - PLANE_PROJECTION_MODE_FULL
```
public static final int PLANE_PROJECTION_MODE_FULL
```
    The specified aspect ratio is ignored.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StraasMediaCore
```
public StraasMediaCore(@NonNull
                       StraasMediaCore.MediaCoreConfig config)
```
    Create a MediaBrowserCompat which could get through getMediaBrowser().
    
    Parameters:
    
    config - configuration of the StraasMediaCore
  - StraasMediaCore
```
public StraasMediaCore(@NonNull
                       Identity identity,
                       @NonNull
                       MediaBrowserCompat.ConnectionCallback callback)
```
    Create a MediaBrowserCompat which could get through getMediaBrowser().
    
    Parameters:
    
    identity - The user who connecting to the Straas MediaBrowserServiceCompat. If you want to change the identity later, use setIdentity(Identity) after MediaBrowserCompat is connected.
    
    callback - The callback which will tell you whether the MediaBrowserCompat is connected or not. If you get MediaBrowserCompat.ConnectionCallback.onConnectionFailed(), normally causing by getting the CredentialFailException, checkout logcat first.
  - StraasMediaCore
```
public StraasMediaCore(@NonNull
                       StraasMediaCore.UiContainer uiContainer,
                       @NonNull
                       Identity identity,
                       @NonNull
                       MediaBrowserCompat.ConnectionCallback callback)
```
    Create a MediaBrowserCompat which could get through getMediaBrowser().
    Use this constructor, you don't have to call setUiContainer(UiContainer) again unless you want to reset the container target.
    
    Parameters:
    
    uiContainer - The container which renders the video track. Normally just put the StraasPlayerView. You could reset the container target later using setUiContainer(UiContainer).
    
    identity - The user who connecting to the Straas MediaBrowserServiceCompat. If you want to change the identity later, use setIdentity(Identity) after MediaBrowserCompat is connected.
    
    callback - The callback which will tell you whether the MediaBrowserCompat is connected or not. If you get MediaBrowserCompat.ConnectionCallback.onConnectionFailed(), normally causing by getting the CredentialFailException, checkout logcat first.
- Method Detail
  - setDisplayMode
```
public void setDisplayMode(int displayMode)
```
    Set how video frame window is displayed.
    
    Parameters:
    
    displayMode - when put device into cardboard, set to {DISPLAY_MODE_CARDBOARD}
  - getPlaneProjectionMode
```
public int getPlaneProjectionMode()
```
  - getDisplayMode
```
public int getDisplayMode()
```
  - setPlaneProjectionMode
```
public void setPlaneProjectionMode(int planeProjectionMode)
```
    Set projection mode when render type is VIDEO_RENDER_TYPE_PLAIN which is a plain instead of sphere.
    
    Parameters:
    
    planeProjectionMode - default is PLANE_PROJECTION_MODE_FIT
  - setIdentity
```
public void setIdentity(Identity identity)
```
    Set a new identity after MediaBrowser is connected. MUST call after getMediaBrowser() is connected, or you will receive IllegalStateException.
    
    Parameters:
    
    identity - The new identity.
    
    See Also:
    
    Identity, #StraasMediaCore(UiContainer, Identity, ConnectionCallback), #StraasMediaCore(Identity, ConnectionCallback)
  - getMediaController
```
@Nullable
public MediaControllerCompat getMediaController()
```
    Returns:
    
    After received MediaBrowserCompat.ConnectionCallback.onConnected(), you could get a non-null MediaControllerCompat, or build your own MediaControllerCompat through MediaBrowserCompat.getSessionToken().
  - setUiContainer
```
public StraasMediaCore setUiContainer(@Nullable
                                      StraasMediaCore.UiContainer uiContainer)
```
    Optional API only if you didn't put it at constructor, or you want to change the container target.
    
    Parameters:
    
    uiContainer - The player view which video and ad will render within it. Use StraasPlayerView is the best choice or you want to implement your self.
    
    See Also:
    
    #StraasMediaCore(UiContainer, Identity, ConnectionCallback)
  - setImaHelper
```
public StraasMediaCore setImaHelper(@NonNull
                                    StraasMediaCore.ImaHelperBase imaHelper)
```
    Optional API only if you need Interactive Media Ad integration.
    Include extension-ima library and give us the ImaHelper.newInstance().
    
    Parameters:
    
    imaHelper - ImaHelper.newInstance()
  - getMediaBrowser
```
@NonNull
public MediaBrowserCompat getMediaBrowser()
```
    This instance reference MAY change any time, DO-NOT keep this reference. Always use getMediaBrowser().
    
    Returns:
    
    The generated MediaBrowserCompat. Use it to connect to the Straas MediaBrowserServiceCompat.

Class StraasMediaCore

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEY_ALL_VIDEO_FORMATS

KEY_CURRENT_VIDEO_FORMAT_INDEX

COMMAND_SET_FORMAT_INDEX

COMMAND_GET_VIDEO_FORMATS

KEY_CURRENT_PLAYBACK_SPEED

COMMAND_GET_PLAYBACK_SPEED

COMMAND_SET_PLAYBACK_SPEED

KEY_NOTIFICATION_OPTIONS

COMMAND_FOREGROUND

COMMAND_STOP_FOREGROUND

COMMAND_DISABLE_AUDIO

COMMAND_PLAY_AT_LIVE_EDGE

COMMAND_PLAYER_RETRY

COMMAND_SET_LOCATION

COMMAND_GET_LOCATION

KEY_LOCATION

EXTRA_IS_AUDIO_DISABLED

KEY_DISABLE_AUDIO

EXTRA_SERVICE_FOREGROUND_IS_ENABLED

EXTRA_CONTENT_TYPE

EXTRA_TEXT_TRACKS_INFO

KEY_PAGE_TOKEN

PLAY_OPTION_SEEK_TIME

PLAY_OPTION_LIVE_LOW_LATENCY

PLAY_OPTION_HLS_LIVE_SYNC_INTERVAL_COUNT

AD_PLAYBACK_ID

EVENT_TYPE

EVENT_PLAYER_ERROR_MESSAGE

EVENT_MEDIA_BROWSER_SERVICE_ERROR

KEY_MEDIA_BROWSER_ERROR_REASON

KEY_MEDIA_BROWSER_ERROR_MESSAGE

KEY_VIDEO_RENDER_TYPE

VIDEO_RENDER_TYPE_NONE

VIDEO_RENDER_TYPE_PLAIN

VIDEO_RENDER_TYPE_360

ITEM_ID_PLAYLIST_PREFIX

LIVE_ID_PREFIX

PARENT_ID_LIVES

PARENT_ID_VODS

SUBSCRIBE_CHILDREN_OPTIONS_SORT

SUBSCRIBE_CHILDREN_OPTIONS_OWNER_MEMBER_ID

SUBSCRIBE_CHILDREN_OPTIONS_CATEGORY_IDS

SUBSCRIBE_CHILDREN_OPTIONS_TYPES

SUBSCRIBE_CHILDREN_OPTIONS_STATUS

LIVE_EXTRA_BROADCAST_START_TIME

LIVE_EXTRA_BROADCAST_STATE

LIVE_EXTRA_BROADCAST_STATE_V2

LIVE_EXTRA_BROADCAST_STATE_LIVE

LIVE_EXTRA_BROADCAST_STATE_WAIT_STREAM

LIVE_EXTRA_EVENT_STATE

LIVE_EXTRA_EVENT_STATE_ENDED

LIVE_EXTRA_EVENT_STATE_READY

LIVE_EXTRA_EVENT_STATE_STARTED

LIVE_EXTRA_STATISTICS_CCU

LIVE_EXTRA_STATISTICS_HIT_COUNT

KEY_EXTRA_TEXT_TRACKS

LIVE_EXTRA_CURRENT_DATE_TIME

DRM_SCHEME_UUID_EXTRA

DRM_LICENSE_URL

DRM_KEY_REQUEST_PROPERTIES

DISPLAY_MODE_NORMAL

DISPLAY_MODE_CARDBOARD

PLANE_PROJECTION_MODE_FIT

PLANE_PROJECTION_MODE_CROP

PLANE_PROJECTION_MODE_FULL

Constructor Detail

StraasMediaCore

StraasMediaCore

StraasMediaCore

Method Detail

setDisplayMode

getPlaneProjectionMode

getDisplayMode