react-native-google-cast/lib/typescript/api/CastContext.d.ts

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

import CastState from '../types/CastState';
import PlayServicesState from '../types/PlayServicesState';
import DiscoveryManager from './DiscoveryManager';
import SessionManager from './SessionManager';
/**
 * A root class containing global objects and state for the Cast SDK. It is the default export of this library.
 *
 * @example
 * ```js
 * import GoogleCast, { CastContext } from 'react-native-google-cast'
 * // GoogleCast and CastContext are equivalent
 * ```
 *
 * @see [Android](https://developers.google.com/android/reference/com/google/android/gms/cast/framework/CastContext) | [iOS](https://developers.google.com/cast/docs/reference/ios/interface_g_c_k_cast_context) | [Chrome](https://developers.google.com/cast/docs/reference/chrome/cast.framework.CastContext)
 */
export default class CastContext {
    /** The DiscoveryManager to manage device discovery. */
    static discoveryManager: DiscoveryManager;
    /** The SessionManager that manages cast sessions. */
    static sessionManager: SessionManager;
    /** The current casting state for the application. */
    static getCastState(): Promise<CastState | null>;
    /**
     * (Android only) Verifies that Google Play services is installed and enabled on this device, and that the version installed on this device is no older than the one required by this client. Can be used to determine if the Cast framework is available.
     *
     * @see [Android](https://developers.google.com/android/reference/com/google/android/gms/common/GoogleApiAvailability#isGooglePlayServicesAvailable(android.content.Context))
     */
    static getPlayServicesState(): Promise<PlayServicesState | null>;
    /**
     * Get the DiscoveryManager to manage device discovery.
     */
    static getDiscoveryManager(): DiscoveryManager;
    /**
     * Get the SessionManager to manage cast sessions.
     */
    static getSessionManager(): SessionManager;
    /**
     * Displays the Cast Dialog programmatically. Users can also open the Cast Dialog by clicking on a Cast Button.
     *
     * Notes:
     * - on Android, the Cast Button needs to be rendered somewhere on the screen (can be hidden) in order for this method to work.
     * - on iOS 14+, the user has to first press the Cast Button manually and grant permissions (once per app install). Until then, this method will not work.
     *
     * @returns `true` if the Cast Dialog was shown, `false` if it was not shown.
     */
    static showCastDialog(): Promise<boolean>;
    /**
     * Displays the Expanded Controls screen programmatically. Users can also open it by clicking on Mini Controls.
     *
     * @returns `true` if the Expanded Controls were shown, `false` if it was not shown.
     */
    static showExpandedControls(): Promise<boolean>;
    /**
     * If it has not been shown before, presents a fullscreen modal view controller that calls attention to the Cast button and displays some brief instructional text about its use.
     *
     * By default, the overlay is only displayed once. To change this, pass `once: false` in the options.
     *
     * @returns Promise that becomes `true` if the view controller was shown, `false` if it was not shown because it had already been shown before, or if the Cast Button was not found.
     */
    static showIntroductoryOverlay(options?: {
        once?: boolean;
    }): Promise<boolean>;
    /**
     * (Android only) Show a dialog with a localized message about the error state. Upon user confirmation (by tapping on dialog) will direct them to the Play Store if Google Play services is out of date or missing, or to system settings if Google Play services is disabled on the device.
     *
     * @param playServicesState state returned from {@link CastContext.getPlayServicesState}. If it's `success`, the dialog will not be shown.
     * @see [Android](https://developers.google.com/android/reference/com/google/android/gms/common/GoogleApiAvailability#showErrorDialogFragment(android.app.Activity,%20int,%20int))
     */
    static showPlayServicesErrorDialog(playServicesState: PlayServicesState): Promise<boolean>;
    /**
     * Listen for changes of the Cast State.
     *
     * @example
     * ```js
     * const subscription = CastContext.onCastStateChanged(castState => {
     *   if (castState === 'connected') {
     *     // ... ready to go
     *   }
     * })
     *
     * // later, to stop listening
     * subscription.remove()
     * ```
     */
    static onCastStateChanged(listener: (castState: CastState) => void): import("react-native").EmitterSubscription;
}