mediasfu-reactnative
Version:
MediaSFU Prebuilt React Native SDK
49 lines (48 loc) • 2.04 kB
TypeScript
import { Socket } from 'socket.io-client';
import { SignalNewConsumerTransportParameters, SignalNewConsumerTransportType } from '../@types/types';
export interface GetProducersPipedParameters extends SignalNewConsumerTransportParameters {
member: string;
signalNewConsumerTransport: SignalNewConsumerTransportType;
[key: string]: any;
}
export interface GetProducersPipedOptions {
nsock: Socket;
islevel: string;
parameters: GetProducersPipedParameters;
}
export type GetProducersPipedType = (options: GetProducersPipedOptions) => Promise<void>;
/**
* Retrieves piped producers and signals new consumer transport for each retrieved producer.
*
* @param {GetProducersPipedOptions} options - The options for getting piped producers.
* @param {Socket} options.nsock - The WebSocket instance used for communication.
* @param {string} options.islevel - A flag indicating the level of the operation.
* @param {GetProducersPipedParameters} options.parameters - Additional parameters for the operation.
* @param {string} options.parameters.member - The member identifier.
* @param {Function} options.parameters.signalNewConsumerTransport - The function to signal new consumer transport.
*
* @returns {Promise<void>} A promise that resolves when the operation is complete.
*
* @throws {Error} If an error occurs during the process of retrieving producers.
*
* @example
* const options = {
* nsock: socketInstance,
* islevel: '1',
* parameters: {
* member: 'memberId',
* signalNewConsumerTransport: async ({ remoteProducerId, islevel, nsock, parameters }) => {
* // Implementation for signaling new consumer transport
* },
* },
* };
*
* getProducersPiped(options)
* .then(() => {
* console.log('Successfully retrieved piped producers');
* })
* .catch((error) => {
* console.error('Error retrieving piped producers:', error);
* });
*/
export declare const getProducersPiped: ({ nsock, islevel, parameters, }: GetProducersPipedOptions) => Promise<void>;