Bitmovin Player API 8.268.0
    Preparing search index...

    Interface GoogleCastRemoteControlConfig

    Configuration interface for remote control of Google Cast (e.g. Chromecast) receivers.

    Example (enable casting with Bitmovin receiver app and custom style):

    {
      type: 'googlecast',
      customReceiverConfig: {
        receiverStylesheetUrl: 'https://mycdn.com/mycustomreceiverstyle.css',
      },
    }

    Example (custom receiver):

    {
      type: 'googlecast',
      receiverApplicationId: '1234ABCD',
      customReceiverConfig: {
        customPropertyName: 'customValue',
      },
    }
    interface GoogleCastRemoteControlConfig {
        customReceiverConfig?: RemoteControlCustomReceiverConfig;
        messageNamespace?: string;
        receiverApplicationId?: string;
        receiverVersion?: "v2" | "v3";
        rejoinActiveSession?: boolean;
        type: "googlecast";
        prepareMediaInfo?(mediaInfo: any): Promise<any>;
    }

    Hierarchy (View Summary)

    Index
    customReceiverConfig? messageNamespace? receiverApplicationId? receiverVersion? rejoinActiveSession? type
    prepareMediaInfo?
    customReceiverConfig?: RemoteControlCustomReceiverConfig

    An arbitrary configuration object that is sent to the receiver when a connection is established. This object can carry configuration values that are of no concern to and are handled outside of the RemoteControl/ RemoteControlReceiver architecture.

    messageNamespace?: string

    The message namespace for communication of advanced player functionality not covered by the Cast media controls. Only overwrite this if you are implementing your own custom receiver.

    receiverApplicationId?: string

    The application ID of the Cast application that should be launched when connecting to a Cast receiver. Set this if you want to use your own custom receiver application. If unset, the Bitmovin player cast application is used.

    receiverVersion?: "v2" | "v3"

    The receiver app version. This is only necessary if providing custom receiverApplicationId and it is using receiver app v3.

    Default is 'v2'

    8.43.0

    rejoinActiveSession?: boolean

    Specifies, whether an existing Cast session shall be re-joined rather than creating a new one when casting starts.

    Default is false.

    8.67.0

    type: "googlecast"

    • Callback providing the possibility to prepare/alter the media info object before it is loaded onto Chromecast receiver app to change its media/source.

      Example:

      prepareMediaInfo: function(mediaInfo) {
        // Signal fMP4 container format for audio and video
        mediaInfo.hlsSegmentFormat = chrome.cast.media.HlsSegmentFormat.FMP4;
        mediaInfo.hlsVideoSegmentFormat = chrome.cast.media.HlsVideoSegmentFormat.FMP4;

        return Promise.resolve(mediaInfo);
      }

      Note: This callback is only supported with Chromecast v3 (CAF) receivers.

      Parameters

      Returns Promise<any>

      A promise resloving with the altered object that the player will load on the receiver.

      8.78.0

    Settings
    Member Visibility

    On This Page
    Properties
    Methods