RemoteControlConfig

@available(visionOS, unavailable)
@objcMembers
@objc(BMPRemoteControlConfig)
public class RemoteControlConfig : NSObject

Contains config values which can be used to alter the behaviour of the player when it comes to remote playback.

  • A URL to a CSS file the Chromecast receiver app loads. Can be used to style the receiver app.

    Declaration

    Swift

    public var receiverStylesheetUrl: URL?

  • Arbitrary config values that are sent to the remote control receiver.

    Declaration

    Swift

    public var customReceiverConfig: [String : String]

  • This block can be used to prepare a different SourceConfig to be used for remote playback than for local playback. This can be useful when the remote playback device supports different streaming formats, DRM systems, etc. than the local device. Returning nil from the block will result in the the same SourceConfig being used for remote playback as for local playback.

    Declaration

    Swift

    public var prepareSource: ((_ type: RemoteControlType, _ sourceConfig: SourceConfig) -> SourceConfig?)?

  • Indicates whether the player should automatically switch to “external playback” mode while the “external screen” mode is active in order to play video content and switch back to “external screen” mode as soon as playback is done. Brief transition may be visible on the external display when automatically switching between the two modes. Default value is false.

    Note

    This is only supported with AirPlay.

    Declaration

    Swift

    public var usesExternalPlaybackWhileExternalScreenIsActive: Bool

  • Indicates whether cookies and credentials will be sent along manifest requests on the Cast receiver

    Default value is false.

    Note

    This is only supported with CAF (v3) receivers.

    Declaration

    Swift

    public var sendManifestRequestsWithCredentials: Bool

  • Indicates whether cookies and credentials will be sent along segment requests on the Cast receiver

    Default value is false.

    Note

    This is only supported with CAF (v3) receivers.

    Declaration

    Swift

    public var sendSegmentRequestsWithCredentials: Bool

  • Indicates whether cookies and credentials will be sent along DRM licence requests on the Cast receiver

    Default value is false.

    Note

    This is only supported with CAF (v3) receivers.

    Declaration

    Swift

    public var sendDrmLicenseRequestsWithCredentials: Bool

  • Whether the AirPlay option is enabled or not.

    Default value is true.

    Note

    • Calling showAirPlayTargetPicker when the value is false will not have any effect.
    • Only available on iOS. Does not have any effect on tvOS.

    Declaration

    Swift

    @available(*, deprecated, renamed: "allowsAirPlay")
public var isAirPlayEnabled: Bool { get set }

  • Whether AirPlay is allowed.

    Default value is true.

    Note

    • Calling showAirPlayTargetPicker when the value is false will not have any effect.
    • Only supported on iOS. Does not have any effect on tvOS.

    Declaration

    Swift

    public var allowsAirPlay: Bool

  • Whether casting is enabled.

    Default value is true. Has no effect if the BitmovinCastManager is not initialized.

    Note

    • Only available on iOS. Does not have any effect on tvOS.

    Declaration

    Swift

    public var isCastEnabled: Bool