Actions Library

Turnkey

Embed-SDK React

Embed-SDK Web

Provides methods to execute specific actions like Muting / Unmuting a user and Joining / Creating a Room.

You can access them under the customization-api module as a named export.

---

useCreateRoom(): createMeeting

Returns an asynchronous function to create a room with the given options.

turnkey

import { useCreateRoom } from "customization-api";

...

const createMeeting = useCreateRoom();

...

await createMeeting(/*roomTitle:*/ 'My Room', /*enablePSTN?:*/ false, /*isSeperateHostLink?:*/ false );

react-sdk

import { useCreateRoom } from "@appbuilder/react";

...

const createMeeting = useCreateRoom();

...

await createMeeting(/*roomTitle:*/ 'My Room', /*enablePSTN?:*/ false, /*isSeperateHostLink?:*/ false );

web-sdk

import { useCreateRoom } from "@appbuilder/web";

...

const createMeeting = useCreateRoom();

...

await createMeeting(/*roomTitle:*/ 'My Room', /*enablePSTN?:*/ false, /*isSeperateHostLink?:*/ false );

Returns:

createMeeting(roomTitle: string, enablePSTN?: boolean, isSeperateHostLink?: boolean): Promise<void>

---

useJoinRoom(): joinRoom

Returns an asynchronous function to join a room with the given phrase.

turnkey

import { useJoinRoom } from "customization-api";

...

const joinRoom = useJoinRoom();

...

await joinRoom(/*roomId:*/ 12342139812);

react-sdk

import { useJoinRoom } from "@appbuilder/react";

...

const joinRoom = useJoinRoom();

...

await joinRoom(/*roomId:*/ 12342139812);

web-sdk

import { useJoinRoom } from "@appbuilder/web";

...

const joinRoom = useJoinRoom();

...

await joinRoom(/*roomId:*/ 12342139812);

Returns:

joinRoom(roomId: string): Promise<void>

---

useMuteToggleLocal(): muteToggleLocal

Returns an asynchronous function to toggle muted state of the given track type for the local user.

turnkey

import { useMuteToggleLocal, MUTE_LOCAL_TYPE } from "customization-api";

...

const muteToggleLocal = useMuteToggleLocal();

...

muteToggleLocal( MUTE_LOCAL_TYPE.audio ); // toggle local user's audio mute state

react-sdk

import { useMuteToggleLocal, MUTE_LOCAL_TYPE } from "@appbuilder/react";

...

const muteToggleLocal = useMuteToggleLocal();

...

muteToggleLocal( MUTE_LOCAL_TYPE.audio ); // toggle local user's audio mute state

web-sdk

import { useMuteToggleLocal, MUTE_LOCAL_TYPE } from "@appbuilder/web";

...

const muteToggleLocal = useMuteToggleLocal();

...

muteToggleLocal( MUTE_LOCAL_TYPE.audio ); // toggle local user's audio mute state

Returns:

muteToggleLocal(type: MUTE_LOCAL_TYPE): Promise<void>

---

useRemoteMute(): muteToggleRemote

Returns an asynchronous function to toggle muted state of the given track type for a remote user with the given uid or if no uid provided, mutes everyone else in the room.

turnkey

import { useRemoteMute, MUTE_REMOTE_TYPE } from "customization-api";

...

const muteToggleRemote = useRemoteMute();

...

muteToggleRemote( MUTE_REMOTE_TYPE.audio, 123457 ); // toggle uid:123457 user's audio mute state

react-sdk

import { useRemoteMute, MUTE_REMOTE_TYPE } from "@appbuilder/react";

...

const muteToggleRemote = useRemoteMute();

...

muteToggleRemote( MUTE_REMOTE_TYPE.audio, 123457 ); // toggle uid:123457 user's audio mute state

web-sdk

import { useRemoteMute, MUTE_REMOTE_TYPE } from "@appbuilder/web";

...

const muteToggleRemote = useRemoteMute();

...

muteToggleRemote( MUTE_REMOTE_TYPE.audio, 123457 ); // toggle uid:123457 user's audio mute state

Returns:

muteToggleLocal(type: MUTE_REMOTE_TYPE, uid?: UidType ): Promise<void>

---

useRemoteEndCall(): remoteEndCall

Returns a function to end the call for a remote user with the given uid.

turnkey

import { useRemoteEndCall } from "customization-api";

...

const remoteEndCall = useRemoteEndCall();

...

remoteEndCall( 123457 ); // end uid:123457 user's call

react-sdk

import { useRemoteEndCall } from "@appbuilder/react";

...

const remoteEndCall = useRemoteEndCall();

...

remoteEndCall( 123457 ); // end uid:123457 user's call

web-sdk

import { useRemoteEndCall } from "@appbuilder/web";

...

const remoteEndCall = useRemoteEndCall();

...

remoteEndCall( 123457 ); // end uid:123457 user's call

Returns:

remoteEndCall(uid: UidType): void

---

useEndCall(): endCall

Returns a function to end the call for a local user.

turnkey

import { useEndCall } from "customization-api";

...

const endCall = useEndCall();

...

endCall(); // end the call for local user

react-sdk

import { useEndCall } from "@appbuilder/react";

...

const endCall = useEndCall();

...

endCall(); // end the call for local user

web-sdk

import { useEndCall } from "@appbuilder/web";

...

const endCall = useEndCall();

...

endCall(); // end the call for local user

Returns:

endCall(): void

---

useLocalAudio(): localAudio

Returns a object that contains enableAudioButton/disableAudioButton function which used to enable/disable local user audio button

turnkey

import { useLocalAudio } from "customization-api";

...

const {enableAudioButton, disableAudioButton} = useLocalAudio();

...

enableAudioButton(); // enable audio button
disableAudioButton(); // disable audio button

react-sdk

import { useLocalAudio } from "@appbuilder/react";

...

const localAudio = useLocalAudio();

...

enableAudioButton(); // enable audio button
disableAudioButton(); // disable audio button

web-sdk

import { useLocalAudio } from "@appbuilder/web";

...

const {enableAudioButton,disableAudioButton} = useLocalAudio();

...

enableAudioButton(); // enable audio button
disableAudioButton(); // disable audio button

Returns:

enableAudioButton(): void

disableAudioButton(): void

---

TYPES:

MUTE_LOCAL_TYPE

Name	Value
audio	0
video	1

turnkey

import { MUTE_LOCAL_TYPE } from "customization-api";

react-sdk

import { MUTE_LOCAL_TYPE } from "@appbuilder/react";

web-sdk

import { MUTE_LOCAL_TYPE } from "@appbuilder/web";

---

MUTE_REMOTE_TYPE

Name	Value
audio	0
video	1

turnkey

import { MUTE_REMOTE_TYPE } from "customization-api";

react-sdk

import { MUTE_REMOTE_TYPE } from "@appbuilder/react";

web-sdk

import { MUTE_REMOTE_TYPE } from "@appbuilder/web";