Class CustomMessageHandler

Android and iOS only. For Android it requires Player SDK version 3.39.0 or higher.

Provides a two-way communication channel between the Player UI and the integration.

Index

Constructors

Methods

receivedAsynchronousMessage receivedSynchronousMessage sendMessage

Constructors

constructor

new CustomMessageHandler(
options: CustomMessageHandlerProps,
): CustomMessageHandler
Android and iOS only.

Creates a new CustomMessageHandler instance to handle two-way communication between the integation and the Player UI.
Parameters
- options: CustomMessageHandlerProps
  Configuration options for the CustomMessageHandler instance.
Returns CustomMessageHandler
- Defined in ui/custommessagehandler.ts:46

Methods

receivedAsynchronousMessage

receivedAsynchronousMessage(message: string, data: undefined | string): void
Gets called when an asynchronous message was received from the Bitmovin Web UI.
Parameters
- message: string
  Identifier of the message.
- data: undefined | string
  Optional data of the message as string (can be a serialized object).
Returns void
- Defined in ui/custommessagehandler.ts:74

receivedSynchronousMessage

receivedSynchronousMessage(
message: string,
data: undefined | string,
): undefined | string
Gets called when a synchronous message was received from the Bitmovin Web UI.
Parameters
- message: string
  Identifier of the message.
- data: undefined | string
  Optional data of the message as string (can be a serialized object).
Returns undefined | string
Optional return value as string which will be propagates back to the JS counterpart.
- Defined in ui/custommessagehandler.ts:61

sendMessage

sendMessage(message: string, data: undefined | string): void
Android and iOS only.

Sends a message to the Player UI.
Parameters
- message: string
  Identifier for the callback which should be called.
- data: undefined | string
  Payload for the callback.
Returns void
- Defined in ui/custommessagehandler.ts:86