bitmovin-player-react-native/build/mediaControlsApi.d.ts

Official React Native bindings for Bitmovin's mobile Player SDKs.

/**
 * Provides control for the Player's media controls integration.
 *
 * Accessible through {@link Player.mediaControls}.
 *
 * @platform iOS, tvOS
 */
export declare class MediaControlsApi {
    /**
     * The native player id that this media controls api is attached to.
     */
    readonly nativeId: string;
    constructor(playerId: string);
    /**
     * Indicates whether the Player publishes media control information and registers media command handlers.
     *
     * The initial value is configured via {@link MediaControlConfig.isEnabled}.
     * Disabling this integration clears the Player's media controls metadata and removes the Player's command handlers.
     *
     * ## Limitations
     * - Google IMA SDK instances that were already created can still publish their own media control information.
     * - This API only controls the Bitmovin Player media controls integration.
     *   It does not manage media controls, sessions, command handlers, or metadata
     *   created directly by the app or by other libraries.
     *
     * @platform iOS, tvOS
     * @returns `true` if the media controls integration is enabled, `false` otherwise. Always `false` on Android.
     */
    isEnabled: () => Promise<boolean>;
    /**
     * Enables or disables the Player's media controls integration at runtime.
     *
     * @platform iOS, tvOS
     * @param enabled Whether the media controls integration should be enabled.
     */
    setEnabled: (enabled: boolean) => Promise<void>;
}
//# sourceMappingURL=mediaControlsApi.d.ts.map