Class ClickAudio

Handles the click event for toggling audio in a media session.

Param: options

The parameters required for handling the audio click event.

Param: options.parameters

The parameters for toggling audio.

Param: options.parameters.checkMediaPermission

Flag indicating whether to check media permission.

Param: options.parameters.hasAudioPermission

Flag indicating if the user has audio permission.

Param: options.parameters.audioPaused

Flag indicating if audio is paused.

Param: options.parameters.audioAlreadyOn

Flag indicating if audio is already turned on.

Param: options.parameters.audioOnlyRoom

Flag indicating if the room is audio-only.

Param: options.parameters.recordStarted

Flag indicating if recording has started.

Param: options.parameters.recordResumed

Flag indicating if recording has resumed.

Param: options.parameters.recordPaused

Flag indicating if recording is paused.

Param: options.parameters.recordStopped

Flag indicating if recording is stopped.

Param: options.parameters.recordingMediaOptions

Media options for recording (e.g., "video", "audio").

Param: options.parameters.islevel

User's level in the application.

Param: options.parameters.youAreCoHost

Flag indicating if the user is a co-host.

Param: options.parameters.adminRestrictSetting

Flag indicating if admin restrictions are set.

Param: options.parameters.audioRequestState

Current state of the audio request.

Param: options.parameters.audioRequestTime

Timestamp of the audio request.

Param: options.parameters.member

Current member's name.

Param: options.parameters.socket

The socket instance for communication.

Param: options.parameters.localSocket

The local socket instance for communication.

Param: options.parameters.roomName

The name of the room.

Param: options.parameters.userDefaultAudioInputDevice

The default audio input device for the user.

Param: options.parameters.micAction

Flag indicating if the microphone action is in progress.

Param: options.parameters.localStream

The user's local media stream.

Param: options.parameters.audioSetting

Current audio setting.

Param: options.parameters.videoSetting

Current video setting.

Param: options.parameters.screenshareSetting

Current screenshare setting.

Param: options.parameters.chatSetting

Current chat setting.

Param: options.parameters.updateRequestIntervalSeconds

Interval for updating request states.

Param: options.parameters.participants

List of participants in the room.

Param: options.parameters.transportCreated

Flag indicating if the transport has been created.

Param: options.parameters.transportCreatedAudio

Flag indicating if audio transport has been created.

Returns

A promise that resolves when the audio click event has been handled.

Remarks

This function performs the following actions:

  • If the event is audio-only, it shows an alert and exits.
  • If the audio is already on, it handles the logic for turning it off, including checking recording states and permissions.
  • If the audio is off, it checks for admin restrictions, user permissions, and handles the logic for turning the audio on.
  • It updates various states and emits socket events as necessary.

Example

const options: ClickAudioOptions = {
  parameters: {
    checkMediaPermission: true,
    hasAudioPermission: false,
    audioPaused: false,
    audioAlreadyOn: false,
    audioOnlyRoom: false,
    recordStarted: false,
    recordResumed: false,
    recordPaused: false,
    recordStopped: false,
    recordingMediaOptions: 'audio',
    islevel: '1',
    youAreCoHost: false,
    adminRestrictSetting: false,
    audioRequestState: null,
    audioRequestTime: 0,
    member: 'John Doe',
    socket: socketInstance,
    localSocket: socketInstance,
    roomName: 'exampleRoom',
    userDefaultAudioInputDevice: 'default',
    micAction: false,
    localStream: null,
    audioSetting: 'enabled',
    videoSetting: 'disabled',
    screenshareSetting: 'disabled',
    chatSetting: 'enabled',
    updateRequestIntervalSeconds: 30,
    participants: [],
    transportCreated: false,
    transportCreatedAudio: false,
    updateAudioAlreadyOn: (status) => console.log(status),
    updateAudioRequestState: (state) => console.log(state),
    updateAudioPaused: (status) => console.log(status),
    updateLocalStream: (stream) => console.log(stream),
    updateParticipants: (participants) => console.log(participants),
    updateTransportCreated: (status) => console.log(status),
    updateTransportCreatedAudio: (status) => console.log(status),
    updateMicAction: (action) => console.log(action),
    checkPermission: async () => 'granted',
    streamSuccessAudio: async () => console.log('Audio streaming success'),
    disconnectSendTransportAudio: async () => console.log('Audio transport disconnected'),
    requestPermissionAudio: async () => 'granted',
    resumeSendTransportAudio: async () => console.log('Audio transport resumed'),
  },
};

const clickAudioService = new ClickAudio();
await clickAudioService.clickAudio(options);

Constructors

constructor

Methods

clickAudio

Constructors

constructor

Methods

clickAudio

  • clickAudio(parameters): Promise<void>

  • Handles the click event for toggling audio in a media session.

    Parameters

    • parameters: ClickAudioOptions

      The parameters required for handling the audio click event.

    Returns Promise<void>

    A promise that resolves when the audio click event has been handled.

    The function performs the following actions:

    • If the event is audio-only, it shows an alert and exits.
    • If the audio is already on, it handles the logic for turning it off, including checking recording states and permissions.
    • If the audio is off, it checks for admin restrictions, user permissions, and handles the logic for turning the audio on.
    • It updates various states and emits socket events as necessary.

    The function makes use of several helper functions and state update functions passed in through the parameters.

Settings

Member Visibility

On This Page

Constructors
Methods