react-native-google-cast/lib/typescript/types/MediaStatus.d.ts

React Native wrapper for the Google Cast SDK for iOS and Android

import MediaInfo from './MediaInfo';
import MediaLiveSeekableRange from './MediaLiveSeekableRange';
import MediaPlayerIdleReason from './MediaPlayerIdleReason';
import MediaPlayerState from './MediaPlayerState';
import MediaQueueItem from './MediaQueueItem';
import MediaRepeatMode from './MediaRepeatMode';
import VideoInfo from './VideoInfo';
/**
 * A class that holds status information about some media or media queue. The current `MediaStatus` can be obtained using `getMediaStatus` or `onMediaStatusUpdated` in {@link RemoteMediaClient}, or using the `useMediaStatus` hook.
 *
 * Each media session is associated with a media queue on the receiver application. The list of media items in the current queue can be obtained from `queueItems`. Media items are assigned a unique item ID. Accessors for individual item and values of properties of the queue are also provided here.
 *
 * `currentItemId`, `loadingItemId` and `preloadedItemId` tells which item is playing, which item is loading and which item has been preloaded on the receiver.
 *
 * @see [Android](https://developers.google.com/android/reference/com/google/android/gms/cast/MediaStatus) | [iOS](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_media_status) | [Chrome](https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.Media)
 */
export default interface MediaStatus {
    /** The list of active {@link MediaTrack} IDs. */
    activeTrackIds?: number[];
    /** The itemId of the {@link MediaQueueItem} that that is currently active in the queue (it may not be playing). */
    currentItemId?: number;
    /** Any custom data that is associated with the media item. */
    customData?: object;
    /** The current idle reason. This value is only meaningful if the `playerState` is `idle`. */
    idleReason?: MediaPlayerIdleReason | null;
    /** The stream's mute state. */
    isMuted: boolean;
    /** The seekable range of a live media stream. If the current media is a live stream and this property is null, then the stream is not seekable. */
    liveSeekableRange?: MediaLiveSeekableRange | null;
    /** The itemId of the {@link MediaQueueItem} that is currently loading (but isn't active in the queue) on the receiver. */
    loadingItemId?: number;
    /** The current media information. */
    mediaInfo?: MediaInfo | null;
    /** Gets the current stream playback rate. This will be negative if the stream is seeking backwards, 0 if the stream is paused, 1 if the stream is playing normally, and some other positive value if the stream is seeking forwards. */
    playbackRate: number;
    /** The current player state. */
    playerState: MediaPlayerState | null;
    /** ID of the next {@link MediaQueueItem}, only available if it has been preloaded. On the receiver media items can be preloaded and cached temporarily in memory, so when they are loaded later on, the process is faster (as the media does not have to be fetched from the network). */
    preloadedItemId?: number;
    /** Readonly list of items in the queue. */
    queueItems: MediaQueueItem[];
    /** The repeat mode for playing the queue. */
    queueRepeatMode?: MediaRepeatMode | null;
    /** The current stream position from the start of the stream, in seconds */
    streamPosition: number;
    /** The video information. If the video information of the current media was not received from the cast receiver, `null` will be returned. */
    videoInfo?: VideoInfo | null;
    /** The stream's volume, between 0.0 and 1.0 */
    volume: number;
}