mediasfu-reactnative
Version:
MediaSFU Prebuilt React Native SDK
75 lines (74 loc) • 3.88 kB
TypeScript
import { ProducerOptions } from 'mediasoup-client/lib/types';
import { ConnectSendTransportAudioType, ConnectSendTransportVideoType, ConnectSendTransportScreenType, ConnectSendTransportAudioParameters, ConnectSendTransportVideoParameters, ConnectSendTransportScreenParameters, MediaStream } from '../@types/types';
export interface ConnectSendTransportParameters extends ConnectSendTransportAudioParameters, ConnectSendTransportVideoParameters, ConnectSendTransportScreenParameters {
audioParams: ProducerOptions;
videoParams: ProducerOptions;
localStreamScreen: MediaStream | null;
canvasStream: MediaStream | null;
whiteboardStarted: boolean;
whiteboardEnded: boolean;
shared: boolean;
islevel: string;
connectSendTransportAudio: ConnectSendTransportAudioType;
connectSendTransportVideo: ConnectSendTransportVideoType;
connectSendTransportScreen: ConnectSendTransportScreenType;
getUpdatedAllParams: () => ConnectSendTransportParameters;
[key: string]: any;
}
export interface ConnectSendTransportOptions {
option: 'audio' | 'video' | 'screen' | 'all';
targetOption?: 'local' | 'remote' | 'all';
parameters: ConnectSendTransportParameters;
}
export type ConnectSendTransportType = (options: ConnectSendTransportOptions) => Promise<void>;
/**
* Connects the send transport based on the specified option.
*
* @param {ConnectSendTransportOptions} options - The options for connecting the send transport.
* @param {string} options.option - The type of transport to connect ('audio', 'video', 'screen', or 'all').
* @param {boolean} options.targetOption - The target option to connect ('local', 'remote', or 'all').
* @param {ConnectSendTransportParameters} options.parameters - The parameters required for connecting the transport.
* @param {ProducerOptions} options.parameters.audioParams - The audio parameters.
* @param {ProducerOptions} options.parameters.videoParams - The video parameters.
* @param {MediaStream} options.parameters.localStreamScreen - The local screen stream.
* @param {MediaStream} options.parameters.canvasStream - The canvas stream.
* @param {boolean} options.parameters.whiteboardStarted - Indicates if the whiteboard has started.
* @param {boolean} options.parameters.whiteboardEnded - Indicates if the whiteboard has ended.
* @param {boolean} options.parameters.shared - Indicates if the screen is shared.
* @param {string} options.parameters.islevel - The level of the screen sharing.
* @param {Function} options.parameters.connectSendTransportAudio - Function to connect the audio send transport.
* @param {Function} options.parameters.connectSendTransportVideo - Function to connect the video send transport.
* @param {Function} options.parameters.connectSendTransportScreen - Function to connect the screen send transport.
*
* @returns {Promise<void>} A promise that resolves when the transport is connected.
*
* @throws Will throw an error if the connection fails.
*
* @example
* const options = {
* option: 'audio',
* targetOption: 'local',
* parameters: {
* audioParams: audioProducerOptions,
* videoParams: videoProducerOptions,
* localStreamScreen: localStream,
* canvasStream: canvasStream,
* whiteboardStarted: false,
* whiteboardEnded: false,
* shared: false,
* islevel: '1',
* connectSendTransportAudio: connectAudioFunction,
* connectSendTransportVideo: connectVideoFunction,
* connectSendTransportScreen: connectScreenFunction,
* },
* };
*
* connectSendTransport(options)
* .then(() => {
* console.log('Transport connected successfully');
* })
* .catch((error) => {
* console.error('Error connecting transport:', error);
* });
*/
export declare const connectSendTransport: ({ option, targetOption, parameters }: ConnectSendTransportOptions) => Promise<void>;