bitmovin-player-react-native/build/ui/custommessagehandler.d.ts

Official React Native bindings for Bitmovin's mobile Player SDKs.

import { CustomMessageSender } from './custommessagesender';
export interface CustomMessageHandlerProps {
    /**
     * A function that will be called when the Player UI sends a synchronous message to the integration.
     */
    onReceivedSynchronousMessage: (message: string, data: string | undefined) => string | undefined;
    /**
     * A function that will be called when the Player UI sends an asynchronous message to the integration.
     */
    onReceivedAsynchronousMessage: (message: string, data: string | undefined) => void;
}
/**
 * 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.
 */
export declare class CustomMessageHandler {
    private readonly onReceivedSynchronousMessage;
    private readonly onReceivedAsynchronousMessage;
    /** @internal */
    customMessageSender?: CustomMessageSender;
    /**
     * Android and iOS only.
     *
     * Creates a new `CustomMessageHandler` instance to handle two-way communication between the integation and the Player UI.
     *
     * @param options - Configuration options for the `CustomMessageHandler` instance.
     */
    constructor({ onReceivedSynchronousMessage, onReceivedAsynchronousMessage, }: CustomMessageHandlerProps);
    /**
     * Gets called when a synchronous message was received from the Bitmovin Web UI.
     *
     * @param message Identifier of the message.
     * @param data Optional data of the message as string (can be a serialized object).
     * @returns Optional return value as string which will be propagates back to the JS counterpart.
     */
    receivedSynchronousMessage(message: string, data: string | undefined): string | undefined;
    /**
     * Gets called when an asynchronous message was received from the Bitmovin Web UI.
     *
     * @param message Identifier of the message.
     * @param data Optional data of the message as string (can be a serialized object).
     */
    receivedAsynchronousMessage(message: string, data: string | undefined): void;
    /**
     * Android and iOS only.
     *
     * Sends a message to the Player UI.
     *
     * @param message - Identifier for the callback which should be called.
     * @param data - Payload for the callback.
     */
    sendMessage(message: string, data: string | undefined): void;
}
//# sourceMappingURL=custommessagehandler.d.ts.map