BMPRemoteControlApi

Objective-C

@protocol BMPRemoteControlApi <NSObject>

Swift

protocol RemoteControlApi : NSObjectProtocol

Provides the means to initiate and manage casting of video to a cast-compatible remote device. Only available on iOS. Result in a no-op on tvOS for all properties and methods.

  • Returns true if the video is currently casted to a device and not played locally, or false if the video is played locally.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isCasting;

    Swift

    var isCasting: Bool { get }

    Return Value

    True if the video is currently casted to a device.

  • Returns true if the player is currently connecting to a device, but the cast session is not yet established.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isWaitingForDevice;

    Swift

    var isWaitingForDevice: Bool { get }

    Return Value

    True if the player is currently connecting to a device.

  • Returns true if casting to another device (such as a ChromeCast) is available, otherwise false. Please note that this function only returns true after the CastAvailableEvent event has fired.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL isCastAvailable;

    Swift

    var isCastAvailable: Bool { get }

    Return Value

    True if casting to another device is available.

  • Stops casting the current video if it is casting at the moment (i.e. RemoteControlApi#isCasting() returns true). Has no effect if RemoteControlApi#isCasting() returns false.

    Declaration

    Objective-C

    - (void)castStop;

    Swift

    func castStop()

  • Initiates casting the current video to a cast-compatible device. The user has to choose to which device it should be sent.

    Declaration

    Objective-C

    - (void)castVideo;

    Swift

    func castVideo()