Gets call ID.
+Gets custom items of this DirectCall instance.
+Gets call duration(ms).
+Gets end result.
+Is ended. +
Is local audio enabled. +
Indicates whether the local user's screen is being shared. +
Is local video enabled. +
Is ongoing. +
Indicates whether the call is on hold by either a callee or a caller, or by both. +
Indicates whether the call is on hold by either a callee or a caller, or by both. True if the DirectCall is on hold. Otherwise, false.
Is remote audio enabled. +
Is remote video enabled. +
Is video call.
+Gets local recording status.
+Gets remote recording status.
+Gets call startedAt timestamp.
+Accepts call.
Add DirectCall listener. +
Add DirectCall listener. supports multiple listeners.
Connects the device audio and Sendbird Calls SDK to stream audio.
+Connects the device camera and Sendbird Calls SDK to stream video.
+Selects audio device.
+Deletes all custom items for this call.
+Deletes all custom items for this call.
Promise that resolves with CustomItemUpdateResult containing updated items and affected keys.
Deletes custom items for this call.
+Deletes custom items for this call.
Custom item keys which you want to delete.
Promise that resolves with CustomItemUpdateResult containing updated items and affected keys.
Ends the call. +
Ends the call. DirectCallListener.onEnded will be called after successful ending. This listener will also be called when the remote user ends the call.
Mutes the audio of local user. +
Mutes the audio of local user. Will trigger DirectCallListener.onRemoteAudioSettingsChanged method of the remote user. If the remote user changes their audio settings, local user will be notified via same delegate method.
Selects video device. +
Selects video device. Changes current video device asynchronously.
Starts local video. +
Starts local video. If the callee changes video settings, the caller is notified via the DirectCallListener.onRemoteVideoSettingsChanged listener.
Stops local video. +
Stops local video. If the callee changes video settings, the caller is notified via the DirectCallListener.onRemoteVideoSettingsChanged listener.
Toggles the selection between the front and the back camera.
+Unmutes the audio of local user. +
Unmutes the audio of local user. Will trigger DirectCallListener.onRemoteAudioSettingsChanged method of the remote user. If the remote user changes their audio settings, local user will be notified via same delegate method.
Updates custom items for this call.
+Updates custom items for this call.
Custom items of [String: String] to be updated or inserted.
Promise that resolves with CustomItemUpdateResult containing updated items and affected keys.
Update local video view.
+Update remote video view.
+OptionalcomponentCatches exceptions generated in descendant components. Unhandled exceptions will cause +
OptionalcomponentCatches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
OptionalcomponentCalled immediately after a component is mounted. Setting state here will trigger re-rendering.
OptionalcomponentCalled immediately after updating occurs. Not called for the initial render.
@@ -78,7 +78,7 @@ things such as scroll position before Component.render render causes changes to it.Note: the presence of this method prevents any of the deprecated lifecycle events from running.
-OptionalshouldCalled to determine whether the change in props and state should trigger a re-render.
+OptionalshouldCalled to determine whether the change in props and state should trigger a re-render.
Component always returns true.
PureComponent implements a shallow comparison on props and state and returns true if any
props or states have changed.
OptionalcomponentCatches exceptions generated in descendant components. Unhandled exceptions will cause +
OptionalcomponentCatches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
OptionalcomponentCalled immediately after a component is mounted. Setting state here will trigger re-rendering.
OptionalcomponentCalled immediately after updating occurs. Not called for the initial render.
@@ -78,7 +78,7 @@ things such as scroll position before Component.render render causes changes to it.Note: the presence of this method prevents any of the deprecated lifecycle events from running.
-OptionalshouldCalled to determine whether the change in props and state should trigger a re-render.
+OptionalshouldCalled to determine whether the change in props and state should trigger a re-render.
Component always returns true.
PureComponent implements a shallow comparison on props and state and returns true if any
props or states have changed.
Mutes the audio of the local user. +
Mutes the audio of the local user. Will trigger RoomListener.onRemoteAudioSettingsChanged method of remote participants. If the remote user changes their audio settings, the local user will be notified via the same method.
Unmutes the audio of the local user. +
Unmutes the audio of the local user. Will trigger RoomListener.onRemoteVideoSettingsChanged method of remote participants. If the remote user changes their video settings, the local user will be notified via the same method.
Unmutes the audio of the local user. +
Unmutes the audio of the local user. Will trigger RoomListener.onRemoteVideoSettingsChanged method of remote participants. If the remote user changes their video settings, the local user will be notified via the same method.
Toggles the selection between the front and the back camera.
+Unmutes the audio of the local user. +
Unmutes the audio of the local user. Will trigger RoomListener.onRemoteAudioSettingsChanged method of remote participants. If the remote user changes their audio settings, the local user will be notified via the same method.
Gets user ID created the room.
+Gets custom items of this Room instance.
+Gets a list of participants who entered the room.
+Gets a list of remote participants who entered the room.
+Gets room ID.
+Gets state of room.
+Gets type of room.
+Add GroupCall Room listener. supports multiple listeners.
Selects audio device +
Selects audio device Changes current audio device asynchronously. Will trigger RoomListener.onAudioDeviceChanged method of the local participant after successfully changing the audio device.
Deletes all custom items from this room.
+Deletes all custom items from this room.
Promise resolving to the update result with updated items and affected keys
Deletes custom items from this room.
+Deletes custom items from this room.
Array of keys to delete
Promise resolving to the update result with updated items and affected keys
Enter the room +
Enter the room Will trigger RoomListener.onRemoteParticipantEntered method of remote participants after successfully entering the room. If a remote participant entered the room, the local user will be notified via the same method.
Exit from the room +
Exit from the room Will trigger RoomListener.onRemoteParticipantExited method of remote participants after successfully exiting the room. If a remote participant exited the room, the local user will be notified via the same method.
Updates custom items for this room. +
Updates custom items for this room. Custom items are key-value pairs that can be stored with the room.
Key-value pairs to update
Promise resolving to the update result with updated items and affected keys
SendbirdCallsModule class for SendbirdCalls
-Gets the current User.
Returns the current User. If SendbirdCalls is not authenticated, null will be returned.
Returns the SDK Logger
+Returns current iOS/Android SDK version.
+An enum that represents state of a room. +
An enum that represents different types of a room. +
Returns current React-Native SDK version.
+Adds sound used in DirectCall such as ringtone and some sound effects with its file name with extension
+Adds sound used in DirectCall such as ringtone and some sound effects with its file name with extension
Handles Firebase message data. +
Authenticates.
+Creates direct call log list query.
+Creates direct call log list query.
Creates a Room for group calls.
+Creates a query for room list with specified parameters.
+Creates a query for room list with specified parameters.
Deauthenticates.
+Deletes all custom items for a given call ID.
+Deletes all custom items for a given call ID.
Deletes custom items for a given call ID.
+Deletes custom items for a given call ID.
Makes a call to user(callee) directly. (1:1 Call). +
Makes a call to user(callee) directly. (1:1 Call). Use the CallOptions object to choose initial call configuration (e.g. muted/unmuted)
Fetches a room instance from Sendbird server.
+Gets a locally-cached room instance by room ID.
-Gets the current User from native
+
Gets a locally-cached room instance by room ID.
+Gets the current User from native
Returns the current User. If SendbirdCalls is not authenticated, null will be returned.
Returns all ongoing calls, including the active call and all calls on hold.
+Returns all ongoing calls, including the active call and all calls on hold.
Initializes SendbirdCalls.
+To receive native-like calls while an app is in the background or closed, a device registration token must be registered to the server. +
To receive native-like calls while an app is in the background or closed, a device registration token must be registered to the server.
Register a device push token after authentication has completed using the SendbirdCalls.ios_registerVoIPPushToken() method.
Show-up a view that allows user to change the system audio route. +
Show-up a view that allows user to change the system audio route. AVRoutePickerView in iOS 11 or later
Unregisters a VoIP push token of specific device. +
Registers push token for current user.
+Registers push token for current user.
on iOS, push token means APNS token. on Android, push token means FCM token.
if (Platform.OS === 'android') {
const fcmToken = await messaging().getToken();
await SendbirdCalls.registerPushToken(fcmToken);
}
if (Platform.OS === 'ios') {
const apnsToken = await messaging().getAPNSToken();
await SendbirdCalls.registerPushToken(apnsToken);
}
Removes sound used in DirectCall with SoundType value.
+Enables / disables dial sound used in DirectCall even when the device is in silent mode. +
Enables / disables dial sound used in DirectCall even when the device is in silent mode. Call this method right after addDirectCallSound.
Set SendbirdCall listener
+Set logger level
+Unregisters push token for current user.
+Updates custom items for a given call ID.
+Updates custom items for a given call ID.
SendbirdError, platform-specific errors are marked as
OptionalcauseReadonlynameOptionalstackStatic ReadonlyErrorReadonlyCAMERA_ALREADY_SWITCHING: 1800400ReadonlyDIAL_CANCELED: 1800100ReadonlyERR_ACTIVE_CALL_IN_PROGRESS: 1800802ReadonlyERR_ANOTHER_CALL_IN_PROGRESS: 1800803ReadonlyERR_CALL_ALREADY_ON_HOLD: 1800801ReadonlyERR_CALL_DOES_NOT_EXIST: 1400102ReadonlyERR_CALL_NOT_CONNECTED_YET: 1800610ReadonlyERR_CALLEE_DOES_NOT_EXIST: 1400103ReadonlyERR_CALLEE_NEVER_AUTHENTICATE: 1400106ReadonlyERR_CAMERA_SWITCH: 1800401ReadonlyERR_CAPTURE_NOT_ALLOWED_ON_AUDIO_CALL: 1800600ReadonlyERR_CHANGING_AUDIO_DEVICE: 1800402ReadonlyERR_CLIENT_ALREADY_ENTERED: 1400122ReadonlyERR_DIAL_MYSELF: 1400104ReadonlyERR_ENTERING_ROOM_STILL_IN_PROGRESS: 1800701ReadonlyERR_EXITING_ROOM_STILL_IN_PROGRESS: 1800703ReadonlyERR_FAILED_TO_ESTABLISH_CONNECTION_TO_RECEIVE_STREAM: 1800705ReadonlyERR_FAILED_TO_ESTABLISH_CONNECTION_TO_SEND_STREAM: 1800704ReadonlyERR_FAILED_TO_GET_IMAGE_FROM_VIDEO_STREAM: 1800603ReadonlyERR_FAILED_TO_OPEN_FILE: 1800613ReadonlyERR_FAILED_TO_START_RECORDING: 1800614ReadonlyERR_FAILED_TO_STOP_RECORDING: 1800615ReadonlyERR_INVALID_CALL_STATUS: 1400101ReadonlyERR_INVALID_RECORDING_TYPE: 1800617ReadonlyERR_INVALID_ROOM_PARTICIPANT: 1400121ReadonlyERR_LOCAL_PARTICIPANT_LOST_CONNECTION: 1800706ReadonlyERR_MALFORMED_DATA: 1800208ReadonlyERR_MEDIA_STREAM_NOT_ALLOWED_ON_HOLD: 1800631ReadonlyERR_NO_PERMISSION: 1400105ReadonlyERR_NO_RESPONSE_DUE_TO_TIMEOUT: 1800203ReadonlyERR_NO_SCREEN_SHARE_EXISTS: 1800623ReadonlyERR_NOT_SUPPORTED_APP_STATE_FOR_SCREEN_SHARE: 1800627ReadonlyERR_NOT_SUPPORTED_BROWSER_FOR_RECORDING: 1800616OptionalcauseReadonlynameOptionalstackStatic ReadonlyErrorReadonlyCAMERA_ALREADY_SWITCHING: 1800400ReadonlyDIAL_CANCELED: 1800100ReadonlyERR_ACTIVE_CALL_IN_PROGRESS: 1800802ReadonlyERR_ANOTHER_CALL_IN_PROGRESS: 1800803ReadonlyERR_CALL_ALREADY_ON_HOLD: 1800801ReadonlyERR_CALL_DOES_NOT_EXIST: 1400102ReadonlyERR_CALL_NOT_CONNECTED_YET: 1800610ReadonlyERR_CALLEE_DOES_NOT_EXIST: 1400103ReadonlyERR_CALLEE_NEVER_AUTHENTICATE: 1400106ReadonlyERR_CAMERA_SWITCH: 1800401ReadonlyERR_CAPTURE_NOT_ALLOWED_ON_AUDIO_CALL: 1800600ReadonlyERR_CHANGING_AUDIO_DEVICE: 1800402ReadonlyERR_CLIENT_ALREADY_ENTERED: 1400122ReadonlyERR_DIAL_MYSELF: 1400104ReadonlyERR_ENTERING_ROOM_STILL_IN_PROGRESS: 1800701ReadonlyERR_EXITING_ROOM_STILL_IN_PROGRESS: 1800703ReadonlyERR_FAILED_TO_ESTABLISH_CONNECTION_TO_RECEIVE_STREAM: 1800705ReadonlyERR_FAILED_TO_ESTABLISH_CONNECTION_TO_SEND_STREAM: 1800704ReadonlyERR_FAILED_TO_GET_IMAGE_FROM_VIDEO_STREAM: 1800603ReadonlyERR_FAILED_TO_OPEN_FILE: 1800613ReadonlyERR_FAILED_TO_START_RECORDING: 1800614ReadonlyERR_FAILED_TO_STOP_RECORDING: 1800615ReadonlyERR_INVALID_CALL_STATUS: 1400101ReadonlyERR_INVALID_RECORDING_TYPE: 1800617ReadonlyERR_INVALID_ROOM_PARTICIPANT: 1400121ReadonlyERR_LOCAL_PARTICIPANT_LOST_CONNECTION: 1800706ReadonlyERR_MALFORMED_DATA: 1800208ReadonlyERR_MEDIA_STREAM_NOT_ALLOWED_ON_HOLD: 1800631ReadonlyERR_NO_PERMISSION: 1400105ReadonlyERR_NO_RESPONSE_DUE_TO_TIMEOUT: 1800203ReadonlyERR_NO_SCREEN_SHARE_EXISTS: 1800623ReadonlyERR_NOT_SUPPORTED_APP_STATE_FOR_SCREEN_SHARE: 1800627ReadonlyERR_NOT_SUPPORTED_BROWSER_FOR_RECORDING: 1800616ReadonlyERR_NOT_SUPPORTED_BROWSER_FOR_SCREEN_SHARE: 1800625ReadonlyERR_NOT_SUPPORTED_OS_VERSION_FOR_RECORDING: 1800618ReadonlyERR_NOT_SUPPORTED_OS_VERSION_FOR_SCREEN_SHARE: 1800624ReadonlyERR_PARTICIPANT_ALREADY_HAS_SEND_ENDPOINT: 1400124ReadonlyERR_PARTICIPANT_ALREADY_IN_ROOM: 1800700ReadonlyERR_PARTICIPANT_NOT_IN_ROOM: 1800702ReadonlyERR_PERMISSION_DENIED_FOR_SCREEN_SHARE: 1800628ReadonlyERR_QUERY_IN_PROGRESS: 1800206ReadonlyERR_RECORDING_ALREADY_IN_PROGRESS: 1800612ReadonlyERR_REQUEST_FAILED: 1800200ReadonlyERR_REQUEST_FAILED_DUE_TO_WEBSOCKET_CONNECTION_LOST: 1800204ReadonlyERR_ROOM_DELETED: 1400126ReadonlyERR_ROOM_MAX_PARTICIPANTS: 1400120ReadonlyERR_SCREEN_SHARE_ALREADY_IN_PROGRESS: 1800622ReadonlyERR_SCREEN_SHARE_FAILED_DUE_TO_UNKNOWN_REASON: 1800626ReadonlyERR_SCREEN_SHARE_REQUEST_BEFORE_CALL_IS_CONNECTED: 1800621ReadonlyERR_SCREEN_SHARE_RESTRICTED_FROM_AUDIO_CALL: 1800620ReadonlyERR_SELECTED_CONTENT_INACCESSIBLE: 1800630ReadonlyERR_SELECTED_CONTENT_NOT_EXIST: 1800629ReadonlyERR_SEND_ENDPOINT_CANNOT_ATTACH: 1400123ReadonlyERR_SERVER_INTERNAL_ERROR: 1400999ReadonlyERR_VIDEO_CALL_NOT_CONNECTED_YET: 1800602ReadonlyERR_VIDEO_VIEW_NOT_READY: 1800601ReadonlyERR_WEBSOCKET_CONNECTION_FAILED: 1800202ReadonlyERR_WEBSOCKET_CONNECTION_NOT_OPENED: 1800201ReadonlyERR_WRONG_RECORDING_TYPE_FOR_AUDIO_CALL: 1800611ReadonlyERR_WRONG_RESPONSE: 1800205ReadonlyINSTANCE_NOT_INITIALIZED: 1800302ReadonlyINTERNAL_SERVER_ERROR: 1800207ReadonlyINVALID_PARAMETER_TYPE: 1800301ReadonlyINVALID_PARAMETER_VALUE: 1800300ReadonlyMY_USER_ID_NOT_ALLOWED: 1800101ReadonlyUSER_NOT_AUTHENTICATED: 1800303StaticstackThe Error.stackTraceLimit property specifies the number of stack frames
+
ReadonlyERR_PARTICIPANT_ALREADY_HAS_SEND_ENDPOINT: 1400124ReadonlyERR_PARTICIPANT_ALREADY_IN_ROOM: 1800700ReadonlyERR_PARTICIPANT_NOT_IN_ROOM: 1800702ReadonlyERR_PERMISSION_DENIED_FOR_SCREEN_SHARE: 1800628ReadonlyERR_QUERY_IN_PROGRESS: 1800206ReadonlyERR_RECORDING_ALREADY_IN_PROGRESS: 1800612ReadonlyERR_REQUEST_FAILED: 1800200ReadonlyERR_REQUEST_FAILED_DUE_TO_WEBSOCKET_CONNECTION_LOST: 1800204ReadonlyERR_ROOM_DELETED: 1400126ReadonlyERR_ROOM_MAX_PARTICIPANTS: 1400120ReadonlyERR_SCREEN_SHARE_ALREADY_IN_PROGRESS: 1800622ReadonlyERR_SCREEN_SHARE_FAILED_DUE_TO_UNKNOWN_REASON: 1800626ReadonlyERR_SCREEN_SHARE_REQUEST_BEFORE_CALL_IS_CONNECTED: 1800621ReadonlyERR_SCREEN_SHARE_RESTRICTED_FROM_AUDIO_CALL: 1800620ReadonlyERR_SELECTED_CONTENT_INACCESSIBLE: 1800630ReadonlyERR_SELECTED_CONTENT_NOT_EXIST: 1800629ReadonlyERR_SEND_ENDPOINT_CANNOT_ATTACH: 1400123ReadonlyERR_SERVER_INTERNAL_ERROR: 1400999ReadonlyERR_VIDEO_CALL_NOT_CONNECTED_YET: 1800602ReadonlyERR_VIDEO_VIEW_NOT_READY: 1800601ReadonlyERR_WEBSOCKET_CONNECTION_FAILED: 1800202ReadonlyERR_WEBSOCKET_CONNECTION_NOT_OPENED: 1800201ReadonlyERR_WRONG_RECORDING_TYPE_FOR_AUDIO_CALL: 1800611ReadonlyERR_WRONG_RESPONSE: 1800205ReadonlyINSTANCE_NOT_INITIALIZED: 1800302ReadonlyINTERNAL_SERVER_ERROR: 1800207ReadonlyINVALID_PARAMETER_TYPE: 1800301ReadonlyINVALID_PARAMETER_VALUE: 1800300ReadonlyMY_USER_ID_NOT_ALLOWED: 1800101ReadonlyUSER_NOT_AUTHENTICATED: 1800303StaticstackThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
-StaticcaptureCreates a .stack property on targetObject, which when accessed returns
+
StaticcaptureCreates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
diff --git a/docs/enums/AVAudioSessionPort.html b/docs/enums/AVAudioSessionPort.html
index bca5efd..3ca2414 100644
--- a/docs/enums/AVAudioSessionPort.html
+++ b/docs/enums/AVAudioSessionPort.html
@@ -1,6 +1,6 @@
AVAudioSessionPort | @sendbird/calls-react-native Enumeration AVAudioSessionPort
Description
AVAudioSession.Port https://developer.apple.com/documentation/avfaudio/avaudiosession/port
-Index
Enumeration Members
airIndex
Enumeration Members
Enumeration Members
air
airPlay: "airPlay"AVB
AVB: "AVB"bluetooth
bluetoothA2DP: "bluetoothA2DP"bluetooth
bluetoothHFP: "bluetoothHFP"port types that refer to either input or output *
-bluetooth
bluetoothLE: "bluetoothLE"built
builtInMic: "builtInMic"built
builtInReceiver: "builtInReceiver"built
builtInSpeaker: "builtInSpeaker"car
carAudio: "carAudio"display
displayPort: "displayPort"fire
fireWire: "fireWire"HDMI
HDMI: "HDMI"headphones
headphones: "headphones"headset
headsetMic: "headsetMic"line
lineIn: "lineIn"input port types *
-line
lineOut: "lineOut"output port types *
-PCI
PCI: "PCI"thunderbolt
thunderbolt: "thunderbolt"usb
usbAudio: "usbAudio"virtual
virtual: "virtual"port types that refer to either input or output *
+input port types *
+output port types *
+The 'accept()' method of the call has failed. *
-The caller has canceled the call before the callee accepts or declines. *
-The call has ended by either the caller or callee after successful connection. *
-Data streaming from either the caller or the callee has stopped due to a WebRTC connection issue while calling. *
-The callee has declined the call. *
-The 'dial()' method of the call has failed. *
-The callee has not either accepted or declined the call for a specific period of time. *
-Default value of the EndResult. *
-The call is accepted on one of the callee’s other devices. All the other devices will receive this call result. *
-Sendbird server failed to establish a media session between the caller and callee within a specific period of time. *
-Unknown *
-The caller has canceled the call before the callee accepts or declines. *
+The call has ended by either the caller or callee after successful connection. *
+Data streaming from either the caller or the callee has stopped due to a WebRTC connection issue while calling. *
+The callee has declined the call. *
+The 'dial()' method of the call has failed. *
+The callee has not either accepted or declined the call for a specific period of time. *
+Default value of the EndResult. *
+The call is accepted on one of the callee’s other devices. All the other devices will receive this call result. *
+Sendbird server failed to establish a media session between the caller and callee within a specific period of time. *
+Unknown *
+An option to record both audios of the local and remote users, and the video of the local user.
-An option to record both audios of the local and remote users, and the video of the remote user.
-An option to record both audios of the local and remote users.
-An option to record the video and audio of the remote user
-An option to record the audio of the remote user.
-An option to record both audios of the local and remote users, and the video of the remote user.
+An option to record both audios of the local and remote users.
+An option to record the video and audio of the remote user
+An option to record the audio of the remote user.
+AVAudioSession.RouteChangeReason https://developer.apple.com/documentation/avfaudio/avaudiosession/routechangereason
-The SDK provides two types of event handlers for various events that client apps may respond to: SendbirdCallListener Listener and DirectCallListener
Register a device-specific onRinging event handler using the SendbirdCalls.setListener() method.
+
Register a device-specific onRinging event handler using the SendbirdCalls.setListener() method.
It is recommended to add the event handler during initialization because it is a prerequisite for detecting onRinging event.
The code below shows the way device-wide events such as incoming calls are handled once SendbirdCallListener.onRinging is added.
SendbirdCalls.setListener({
onRinging(callProps: DirectCallProperties) {
// Process incoming call
},
});
@@ -114,7 +114,7 @@ - SendbirdCallListener
NOTE: You can set up only one SendbirdCallListener.
-- DirectCallListener
Register a call-specific DirectCallListener event handler using the DirectCall.addListener() method.
+
- DirectCallListener
Register a call-specific DirectCallListener event handler using the DirectCall.addListener() method.
Responding to call-specific events, such as establishing a successful call connection, is then handled as shown below:
const unsubscribe = directCall.addListener({
onEstablished: (call: DirectCallProperties) => {},
onConnected: (call: DirectCallProperties) => {},
onEnded: (call: DirectCallProperties) => {},
onRemoteAudioSettingsChanged: (call: DirectCallProperties) => {},
onRemoteVideoSettingsChanged: (call: DirectCallProperties) => {},
onCustomItemsUpdated: (call: DirectCallProperties, updatedKeys: string[]) => {},
onCustomItemsDeleted: (call: DirectCallProperties, deletedKeys: string[]) => {},
onReconnecting: (call: DirectCallProperties) => {},
onReconnected: (call: DirectCallProperties) => {},
onAudioDeviceChanged: (call: DirectCallProperties, info: AudioDeviceChangedInfo) => {},
onRemoteRecordingStatusChanged: (call: DirectCallProperties) => {},
onUserHoldStatusChanged: (call: DirectCallProperties, isLocalUser: boolean, isUserOnHold: boolean) => {},
onLocalVideoSettingsChanged: (call: DirectCallProperties) => {},
});
unsubscribe();
@@ -351,7 +351,7 @@ End a call// End a call
call.end();
// receives the event
directCall.addListener({
// ...
onEnded: (callProps: DirectCallProperties) => {
// Consider releasing or destroying call-related view from here.
},
});
+Unregister a push token and deauthenticate a user
- Unregister one or all VoIP push tokens
Warning: unregister all is not supported yet.
Users will no longer receive call notifications after the VoIP push token has been unregistered @@ -359,7 +359,7 @@
const unregisterPushToken = () => {
SendbirdCalls.unregisterPushToken(TOKEN);
// or
SendbirdCalls.ios_unregisterVoIPPushToken(TOKEN);
}; -- Deauthenticate a user
When users log out of their call client apps, they must be deauthenticated with
+SendbirdCalls.deauthenticate()method.- Deauthenticate a user
When users log out of their call client apps, they must be deauthenticated with
SendbirdCalls.deauthenticate()method.@@ -426,7 +426,7 @@const signOut = () => {
SendbirdCalls.deauthenticate();
};Timeout optionsSound effects
You should add files to your native project for Android, add your files to
-res/raw/{filename}.mp3for iOS, when you add files to a project, xcode automatically added to the bundled resources (Build Phases > Copy Bundle Resources)- Sound types
+
- Sound types
Type @@ -452,7 +452,7 @@- Sound types- Add sound
+
- Add sound
-
Method @@ -487,7 +487,7 @@- Add sound
- Remove sound
+
- Remove sound
Method @@ -595,11 +595,11 @@Step 3: Create a roomNote: Share the room ID with other users for them to enter the room from the client app.
Step 4: Enter a room
A user can search a room with a specific
-ROOM_IDto participate in a group call at any time.- retrieve a room instance
To enter a room, you must first acquire the room instance from Sendbird server with the room ID. To fetch the most up-to-date room instance from Sendbird server, use the
+SendbirdCalls.fetchRoomById()method. Also, you can use theSendbirdCalls.getCachedRoomById()method that returns the most recently cached room instance from Sendbird Calls SDK.- retrieve a room instance
To enter a room, you must first acquire the room instance from Sendbird server with the room ID. To fetch the most up-to-date room instance from Sendbird server, use the
SendbirdCalls.fetchRoomById()method. Also, you can use theSendbirdCalls.getCachedRoomById()method that returns the most recently cached room instance from Sendbird Calls SDK.-// get room instance using ROOM_ID
const room = await SendbirdCalls.fetchRoomById(ROOM_ID);
// get cached room instance using ROOM_ID
const cachedRoom = await SendbirdCalls.getCachedRoomById(ROOM_ID);- enter a room
Once the room is retrieved, call the
+enter()method to enter the room. An object that sets whether to use video and audio is passed toenter()as a parameter. If no parameters are passed, both audio and video are enabled as default.- enter a room
Once the room is retrieved, call the
enter()method to enter the room. An object that sets whether to use video and audio is passed toenter()as a parameter. If no parameters are passed, both audio and video are enabled as default.When a user enters a room, a participant is created with a unique
participant IDto represent the user in the room.If you create a room using
SendbirdCalls.createRoom(), you can use the returned room instance without needing to get a room instance.const enterParams: EnterParams = {
audioEnabled: true,
videoEnabled: true,
}
await room.enter(enterParams) @@ -609,7 +609,7 @@- enter a roomStep 5: Handle events in a room
A user can receive events of a room that they are currently participating. Users will be notified when other participants enter or leave the room, change their media settings, or when the room is deleted.
-- Add event listener
Add an event listener for the user to receive events that occur in a room that the user joins as a participant.
+- Add event listener
Add an event listener for the user to receive events that occur in a room that the user joins as a participant.
@@ -848,4 +848,4 @@const unsubscribe = room.addListener({
onRemoteParticipantEntered: (participant: Participant) => {},
onRemoteParticipantExited: (participant: Participant) => {},
onRemoteParticipantStreamStarted: (participant: Participant) => {},
onRemoteVideoSettingsChanged: (participant: Participant) => {},
onRemoteAudioSettingsChanged: (participant: Participant) => {},
onAudioDeviceChanged: (info: AudioDeviceChangedInfo) => {},
onCustomItemsUpdated: (updatedKeys: string[]) => {},
onCustomItemsDeleted: (deletedKeys: string[]) => {},
onDeleted: () => {},
onError: (e: SendbirdError, participant: Participant | null) => {},
});
unsubscribe();Call relay protocolHow STUN and TURN works
Session Traversal Utilities for NAT (STUN) is a protocol that helps hosts to discover the presence of a NAT and the IP address, which eventually makes the connection between two endpoints. Traversal Using Relays around NAT (TURN) is a protocol that serves as a relay extension for data between two parties.
Sendbird Calls first try to make a P2P connection directly using the Calls SDK. If a user is behind a NAT/Firewall, Calls will discover the host's public IP address as a location to establish connection using STUN. In most cases, STUN server is only used during the connection setup and once the session has been established, media will flow directly between two users. If the NAT/Firewall still won't allow the two users to connect directly, TURN server will be used to make a connection to relay the media data between two users. Most of the WebRTC traffic is connected with STUN.
- Last Updated: June 17th, 2022
-
+
diff --git a/docs/interfaces/AuthenticateParams.html b/docs/interfaces/AuthenticateParams.html index 90ed1de..2dfe948 100644 --- a/docs/interfaces/AuthenticateParams.html +++ b/docs/interfaces/AuthenticateParams.html @@ -1,3 +1,3 @@ -AuthenticateParams | @sendbird/calls-react-native diff --git a/docs/interfaces/BaseVideoViewProps.html b/docs/interfaces/BaseVideoViewProps.html index 088cfbf..80e1078 100644 --- a/docs/interfaces/BaseVideoViewProps.html +++ b/docs/interfaces/BaseVideoViewProps.html @@ -1,4 +1,4 @@ -Interface AuthenticateParams
Index
Properties
accessToken? + AuthenticateParams | @sendbird/calls-react-native +Interface AuthenticateParams
Index
Properties
BaseVideoViewProps | @sendbird/calls-react-native diff --git a/docs/interfaces/DirectCallListener.html b/docs/interfaces/DirectCallListener.html index e81c709..413a0f1 100644 --- a/docs/interfaces/DirectCallListener.html +++ b/docs/interfaces/DirectCallListener.html @@ -1,4 +1,4 @@ -Interface BaseVideoViewProps
interface BaseVideoViewProps {
android_zOrderMediaOverlay?: boolean;
mirror?: boolean;
resizeMode?: "contain" | "cover" | "center";
}Hierarchy (View Summary)
- BaseVideoViewProps
Index
Properties
android_z Order Media Overlay? + BaseVideoViewProps | @sendbird/calls-react-native +Interface BaseVideoViewProps
interface BaseVideoViewProps {
android_zOrderMediaOverlay?: boolean;
mirror?: boolean;
resizeMode?: "contain" | "cover" | "center";
}Hierarchy (View Summary)
- BaseVideoViewProps
Index
Properties
DirectCallListener | @sendbird/calls-react-native Interface DirectCallListener
interface DirectCallListener {
onAudioDeviceChanged: (
call: DirectCallProperties,
info: AudioDeviceChangedInfo,
) => void;
onConnected: (call: DirectCallProperties) => void;
onCustomItemsDeleted: (
call: DirectCallProperties,
deletedKeys: string[],
) => void;
onCustomItemsUpdated: (
call: DirectCallProperties,
updatedKeys: string[],
) => void;
onEnded: (call: DirectCallProperties) => void;
onEstablished: (call: DirectCallProperties) => void;
onLocalVideoSettingsChanged: (call: DirectCallProperties) => void;
onPropertyUpdatedManually: (call: DirectCallProperties) => void;
onReconnected: (call: DirectCallProperties) => void;
onReconnecting: (call: DirectCallProperties) => void;
onRemoteAudioSettingsChanged: (call: DirectCallProperties) => void;
onRemoteRecordingStatusChanged: (call: DirectCallProperties) => void;
onRemoteVideoSettingsChanged: (call: DirectCallProperties) => void;
onUserHoldStatusChanged: (
call: DirectCallProperties,
isLocalUser: boolean,
isUserOnHold: boolean,
) => void;
}
Index
Properties
onAudio Device Changed + DirectCallListener | @sendbird/calls-react-native Interface DirectCallListener
interface DirectCallListener {
onAudioDeviceChanged: (
call: DirectCallProperties,
info: AudioDeviceChangedInfo,
) => void;
onConnected: (call: DirectCallProperties) => void;
onCustomItemsDeleted: (
call: DirectCallProperties,
deletedKeys: string[],
) => void;
onCustomItemsUpdated: (
call: DirectCallProperties,
updatedKeys: string[],
) => void;
onEnded: (call: DirectCallProperties) => void;
onEstablished: (call: DirectCallProperties) => void;
onLocalVideoSettingsChanged: (call: DirectCallProperties) => void;
onPropertyUpdatedManually: (call: DirectCallProperties) => void;
onReconnected: (call: DirectCallProperties) => void;
onReconnecting: (call: DirectCallProperties) => void;
onRemoteAudioSettingsChanged: (call: DirectCallProperties) => void;
onRemoteRecordingStatusChanged: (call: DirectCallProperties) => void;
onRemoteVideoSettingsChanged: (call: DirectCallProperties) => void;
onUserHoldStatusChanged: (
call: DirectCallProperties,
isLocalUser: boolean,
isUserOnHold: boolean,
) => void;
}
Index
Properties
onAudio Device Changed on Connected on Custom Items Deleted on Custom Items Updated @@ -17,37 +17,37 @@ See also: AVAudioSession.setPreferredInput https://developer.apple.com/documentation/avfaudio/avaudiosession/1616491-setpreferredinput See also: AVRoutePickerView https://developer.apple.com/documentation/avkit/avroutepickerview on
Connected Called when media streams between the caller and callee are connected and audio/video is enabled.
+on
Connected Called when media streams between the caller and callee are connected and audio/video is enabled.
on
Custom Items Deleted Called when the custom items of the call are deleted.
+on
Custom Items Deleted Called when the custom items of the call are deleted.
on
Custom Items Updated Called when the custom items of the call are updated.
+on
Custom Items Updated Called when the custom items of the call are updated.
on
Ended Called when the call has ended.
+on
Ended Called when the call has ended.
on
Established Called when the callee has accepted the call, but not yet connected to media streams.
+on
Established Called when the callee has accepted the call, but not yet connected to media streams.
on
Local Video Settings Changed Called when the local user changes audio settings.
+on
Local Video Settings Changed Called when the local user changes audio settings.
on
Property Updated Manually Called when the update properties internally on Javascript side
+on
Property Updated Manually Called when the update properties internally on Javascript side
on
Reconnected Called when DirectCall successfully reconnects to the server.
+on
Reconnected Called when DirectCall successfully reconnects to the server.
on
Reconnecting Called when DirectCall begins attempting to reconnect to the server after losing connection.
+on
Reconnecting Called when DirectCall begins attempting to reconnect to the server after losing connection.
on
Remote Audio Settings Changed Called when the remote user changes audio settings.
+on
Remote Audio Settings Changed Called when the remote user changes audio settings.
on
Remote Recording Status Changed Called when the other user’s recording status is changed. +
on
Remote Recording Status Changed Called when the other user’s recording status is changed. You can check the recording status of the other user with DirectCall.remoteRecordingStatus
on
Remote Video Settings Changed Called when the remote user changes video settings.
+on
Remote Video Settings Changed Called when the remote user changes video settings.
on
User Hold Status Changed onUserHoldStatusChanged: (
call: DirectCallProperties,
isLocalUser: boolean,
isUserOnHold: boolean,
) => voidThe local or remote user has put a call on hold or removed a hold from a call and their hold status has changed.
++ diff --git a/docs/interfaces/DirectCallLog.html b/docs/interfaces/DirectCallLog.html index ac7777e..9a5b469 100644 --- a/docs/interfaces/DirectCallLog.html +++ b/docs/interfaces/DirectCallLog.html @@ -1,4 +1,4 @@ - on
User Hold Status Changed onUserHoldStatusChanged: (
call: DirectCallProperties,
isLocalUser: boolean,
isUserOnHold: boolean,
) => voidThe local or remote user has put a call on hold or removed a hold from a call and their hold status has changed.
Type Declaration
- (call: DirectCallProperties, isLocalUser: boolean, isUserOnHold: boolean): void
Parameters
- call: DirectCallProperties
DirectCall that has updated user hold status
- isLocalUser: boolean
Returns true if the user whose hold status changed is local user
- isUserOnHold: boolean
Returns true if the user's hold status is changed to on hold
Returns void
DirectCallLog | @sendbird/calls-react-native diff --git a/docs/interfaces/DirectCallMethods.html b/docs/interfaces/DirectCallMethods.html index 8b04963..d81b7a6 100644 --- a/docs/interfaces/DirectCallMethods.html +++ b/docs/interfaces/DirectCallMethods.html @@ -1,4 +1,4 @@ -Interface DirectCallLog
interface DirectCallLog {
callee: null | DirectCallUser;
caller: null | DirectCallUser;
callId: string;
customItems: Record<string, string>;
duration: number;
endedAt: number;
endedBy: null | DirectCallUser;
endResult: DirectCallEndResult;
isFromServer: boolean;
isVideoCall: boolean;
myRole: DirectCallUserRole;
startedAt: number;
}
Index
Properties
callee +DirectCallLog | @sendbird/calls-react-native +Interface DirectCallLog
interface DirectCallLog {
callee: DirectCallUser | null;
caller: DirectCallUser | null;
callId: string;
customItems: Record<string, string>;
duration: number;
endedAt: number;
endedBy: DirectCallUser | null;
endResult: DirectCallEndResult;
isFromServer: boolean;
isVideoCall: boolean;
myRole: DirectCallUserRole;
startedAt: number;
}
Index
Properties
DirectCallMethods | @sendbird/calls-react-native diff --git a/docs/interfaces/DirectCallProperties.html b/docs/interfaces/DirectCallProperties.html index 659c3ad..d5bdc65 100644 --- a/docs/interfaces/DirectCallProperties.html +++ b/docs/interfaces/DirectCallProperties.html @@ -1,4 +1,4 @@ -Interface DirectCallMethods
interface DirectCallMethods {
android_resumeAudioTrack: (...args: []) => void;
android_resumeVideoCapturer: (...args: []) => void;
android_selectAudioDevice: (...args: [device: AudioDeviceType]) => Promise;
muteMicrophone: (...args: []) => void;
selectVideoDevice: (...args: [device: VideoDevice]) => Promise;
startVideo: (...args: []) => void;
stopVideo: (...args: []) => void;
switchCamera: (...args: []) => Promise;
unmuteMicrophone: (...args: []) => void;
accept(...args: [options: CallOptions, holdActiveCall: boolean]): Promise;
addListener(listener: Partial<DirectCallListener>): () => void;
deleteAllCustomItems(): Promise<CustomItemUpdateResult>;
deleteCustomItems(
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
end(...args: []): Promise;
updateCustomItems(
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
updateLocalVideoView(...args: [videoViewId: number]): void;
updateRemoteVideoView(...args: [videoViewId: number]): void;
}Hierarchy
- JSDirectCallModule
- JSDirectCallMediaDeviceControl
- DirectCallMethods
Implemented by
Index
Properties
android_resume Audio Track + DirectCallMethods | @sendbird/calls-react-native +Interface DirectCallMethods
interface DirectCallMethods {
android_resumeAudioTrack: (...args: []) => void;
android_resumeVideoCapturer: (...args: []) => void;
android_selectAudioDevice: (...args: [device: AudioDeviceType]) => Promise;
muteMicrophone: (...args: []) => void;
selectVideoDevice: (...args: [device: VideoDevice]) => Promise;
startVideo: (...args: []) => void;
stopVideo: (...args: []) => void;
switchCamera: (...args: []) => Promise;
unmuteMicrophone: (...args: []) => void;
accept(...args: [options: CallOptions, holdActiveCall: boolean]): Promise;
addListener(listener: Partial<DirectCallListener>): () => void;
deleteAllCustomItems(): Promise<CustomItemUpdateResult>;
deleteCustomItems(
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
end(...args: []): Promise;
updateCustomItems(
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
updateLocalVideoView(...args: [videoViewId: number]): void;
updateRemoteVideoView(...args: [videoViewId: number]): void;
}Hierarchy
- JSDirectCallModule
- JSDirectCallMediaDeviceControl
- DirectCallMethods
Implemented by
Index
Properties
android_
resume Audio Track android_resumeAudioTrack: (...args: []) => voidandroid_
resume Video Capturer android_resumeVideoCapturer: (...args: []) => voidandroid_
select Audio Device mute
Microphone muteMicrophone: (...args: []) => voidselect
Video Device start
Video startVideo: (...args: []) => voidstop
Video stopVideo: (...args: []) => voidswitch
Camera switchCamera: (...args: []) => Promiseunmute
Microphone unmuteMicrophone: (...args: []) => void
Methods
accept
Parameters
- ...args: [options: CallOptions, holdActiveCall: boolean]
Returns Promise
add
Listener
Parameters
- listener: Partial<DirectCallListener>
Returns () => void
delete
All Custom Items
Returns Promise<CustomItemUpdateResult>
delete
Custom Items
Parameters
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
end
Parameters
- ...args: []
Returns Promise
update
Custom Items
Parameters
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
update
Local Video View
Parameters
- ...args: [videoViewId: number]
Returns void
update
Remote Video View
Parameters
- ...args: [videoViewId: number]
Returns void
Properties
android_
resume Audio Track android_resumeAudioTrack: (...args: []) => voidandroid_
resume Video Capturer android_resumeVideoCapturer: (...args: []) => voidandroid_
select Audio Device mute
Microphone muteMicrophone: (...args: []) => voidselect
Video Device start
Video startVideo: (...args: []) => voidstop
Video stopVideo: (...args: []) => voidswitch
Camera switchCamera: (...args: []) => Promiseunmute
Microphone unmuteMicrophone: (...args: []) => void
Methods
accept
Parameters
- ...args: [options: CallOptions, holdActiveCall: boolean]
Returns Promise
add
Listener
Parameters
- listener: Partial<DirectCallListener>
Returns () => void
delete
All Custom Items
Returns Promise<CustomItemUpdateResult>
delete
Custom Items
Parameters
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
end
Parameters
- ...args: []
Returns Promise
update
Custom Items
Parameters
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
update
Local Video View
Parameters
- ...args: [videoViewId: number]
Returns void
update
Remote Video View
Parameters
- ...args: [videoViewId: number]
Returns void
DirectCallProperties | @sendbird/calls-react-native Interface DirectCallProperties
interface DirectCallProperties {
android_availableAudioDevices: AudioDeviceType[];
android_currentAudioDevice: null | AudioDeviceType;
availableVideoDevices: VideoDevice[];
callee: null | DirectCallUser;
caller: null | DirectCallUser;
callId: string;
callLog: null | DirectCallLog;
currentVideoDevice: null | VideoDevice;
customItems: Record<string, string>;
duration: number;
endedBy: null | DirectCallUser;
endResult: DirectCallEndResult;
ios_callUUID: null | string;
isEnded: boolean;
isLocalAudioEnabled: boolean;
isLocalScreenShareEnabled: boolean;
isLocalVideoEnabled: boolean;
isOngoing: boolean;
isOnHold: boolean;
isRemoteAudioEnabled: boolean;
isRemoteVideoEnabled: boolean;
isVideoCall: boolean;
localRecordingStatus: RecordingStatus;
localUser: null | DirectCallUser;
myRole: null | DirectCallUserRole;
remoteRecordingStatus: RecordingStatus;
remoteUser: null | DirectCallUser;
startedAt: number;
}Implemented by
Index
Properties
android_available Audio Devices + DirectCallProperties | @sendbird/calls-react-native Interface DirectCallProperties
interface DirectCallProperties {
android_availableAudioDevices: AudioDeviceType[];
android_currentAudioDevice: AudioDeviceType | null;
availableVideoDevices: VideoDevice[];
callee: DirectCallUser | null;
caller: DirectCallUser | null;
callId: string;
callLog: DirectCallLog | null;
currentVideoDevice: VideoDevice | null;
customItems: Record<string, string>;
duration: number;
endedBy: DirectCallUser | null;
endResult: DirectCallEndResult;
ios_callUUID: string | null;
isEnded: boolean;
isLocalAudioEnabled: boolean;
isLocalScreenShareEnabled: boolean;
isLocalVideoEnabled: boolean;
isOngoing: boolean;
isOnHold: boolean;
isRemoteAudioEnabled: boolean;
isRemoteVideoEnabled: boolean;
isVideoCall: boolean;
localRecordingStatus: RecordingStatus;
localUser: DirectCallUser | null;
myRole: DirectCallUserRole | null;
remoteRecordingStatus: RecordingStatus;
remoteUser: DirectCallUser | null;
startedAt: number;
}Implemented by
Index
Properties
android_available Audio Devices android_ current Audio Device available Video Devices callee @@ -29,70 +29,70 @@ android_
current Audio Device Gets current audio device.
available
Video Devices Gets available video devices. +
available
Video Devices Gets available video devices. List of available VideoDevice.
callee
Gets callee.
+callee
Gets callee.
caller
Gets caller.
+caller
Gets caller.
call
Id callId: stringGets call ID.
+call
Id callId: stringGets call ID.
call
Log Gets call log.
+call
Log Gets call log.
current
Video Device Gets current video device.
+current
Video Device Gets current video device.
custom
Items customItems: Record<string, string>Gets custom items of this DirectCall instance.
+custom
Items customItems: Record<string, string>Gets custom items of this DirectCall instance.
duration
duration: numberGets call duration(ms).
+duration
duration: numberGets call duration(ms).
ended
By Gets ender.
+ended
By Gets ender.
end
Result Gets end result.
+end
Result Gets end result.
ios_
call UUID ios_callUUID: null | stringThe UUID form of callId. Useful when dealing with CallKit.
+ios_
call UUID ios_callUUID: string | nullThe UUID form of callId. Useful when dealing with CallKit.
is
Ended isEnded: booleanIs ended. +
is
Ended isEnded: booleanIs ended. True if call is ended. Otherwise, false.
is
Local Audio Enabled isLocalAudioEnabled: booleanIs local audio enabled. +
is
Local Audio Enabled isLocalAudioEnabled: booleanIs local audio enabled. True if local audio is enabled. Otherwise, false.
is
Local Screen Share Enabled isLocalScreenShareEnabled: booleanIndicates whether the local user's screen is being shared. +
is
Local Screen Share Enabled isLocalScreenShareEnabled: booleanIndicates whether the local user's screen is being shared. True if the local user's screen is being shared. Otherwise, false.
is
Local Video Enabled isLocalVideoEnabled: booleanIs local video enabled. +
is
Local Video Enabled isLocalVideoEnabled: booleanIs local video enabled. True if local video is enabled. Otherwise, false.
is
Ongoing isOngoing: booleanIs ongoing. +
is
Ongoing isOngoing: booleanIs ongoing. True if call is ongoing. Otherwise, false.
is
On Hold isOnHold: booleanIndicates whether the call is on hold by either a callee or a caller, or by both. +
is
On Hold isOnHold: booleanIndicates whether the call is on hold by either a callee or a caller, or by both. True if the DirectCall is on hold. Otherwise, false.
is
Remote Audio Enabled isRemoteAudioEnabled: booleanIs remote audio enabled. +
is
Remote Audio Enabled isRemoteAudioEnabled: booleanIs remote audio enabled. True if remote audio is enabled. Otherwise, false.
is
Remote Video Enabled isRemoteVideoEnabled: booleanIs remote video enabled. +
is
Remote Video Enabled isRemoteVideoEnabled: booleanIs remote video enabled. True if remote video is enabled. Otherwise, false.
is
Video Call isVideoCall: booleanIs video call.
+is
Video Call isVideoCall: booleanIs video call.
local
Recording Status Gets local recording status.
+local
Recording Status Gets local recording status.
local
User Gets local user.
+local
User Gets local user.
my
Role Gets my role.
+my
Role Gets my role.
remote
Recording Status Gets remote recording status.
+remote
Recording Status Gets remote recording status.
remote
User Gets remote user.
+remote
User Gets remote user.
started
At startedAt: numberGets call startedAt timestamp.
++ diff --git a/docs/interfaces/DirectCallUser.html b/docs/interfaces/DirectCallUser.html index 67efe12..c92c317 100644 --- a/docs/interfaces/DirectCallUser.html +++ b/docs/interfaces/DirectCallUser.html @@ -1,7 +1,7 @@ - started
At startedAt: numberGets call startedAt timestamp.
DirectCallUser | @sendbird/calls-react-native diff --git a/docs/interfaces/DirectCallVideoViewProps.html b/docs/interfaces/DirectCallVideoViewProps.html index 591c6e4..e9486b3 100644 --- a/docs/interfaces/DirectCallVideoViewProps.html +++ b/docs/interfaces/DirectCallVideoViewProps.html @@ -1,4 +1,4 @@ -Interface DirectCallUser
interface DirectCallUser {
isActive: boolean;
metaData: Record<string, string>;
nickname: string;
profileUrl: string;
role: DirectCallUserRole;
userId: string;
}Hierarchy (View Summary)
- User
- DirectCallUser
Index
Properties
isActive + DirectCallUser | @sendbird/calls-react-native +Interface DirectCallUser
interface DirectCallUser {
isActive: boolean;
metaData: Record<string, string>;
nickname: string;
profileUrl: string;
role: DirectCallUserRole;
userId: string;
}Hierarchy (View Summary)
- User
- DirectCallUser
DirectCallVideoViewProps | @sendbird/calls-react-native Interface DirectCallVideoViewProps
interface DirectCallVideoViewProps {
accessibilityActions?: readonly Readonly<
{ label?: string; name: string },
>[];
accessibilityElementsHidden?: boolean;
accessibilityHint?: string;
accessibilityIgnoresInvertColors?: boolean;
accessibilityLabel?: string;
accessibilityLabelledBy?: string | string[];
accessibilityLanguage?: string;
accessibilityLargeContentTitle?: string;
accessibilityLiveRegion?: "none" | "polite" | "assertive";
accessibilityRole?: AccessibilityRole;
accessibilityShowsLargeContentViewer?: boolean;
accessibilityState?: AccessibilityState;
accessibilityValue?: AccessibilityValue;
accessibilityViewIsModal?: boolean;
accessible?: boolean;
android_zOrderMediaOverlay?: boolean;
"aria-busy"?: boolean;
"aria-checked"?: boolean | "mixed";
"aria-disabled"?: boolean;
"aria-expanded"?: boolean;
"aria-hidden"?: boolean;
"aria-label"?: string;
"aria-labelledby"?: string;
"aria-live"?: "polite" | "assertive" | "off";
"aria-modal"?: boolean;
"aria-selected"?: boolean;
"aria-valuemax"?: number;
"aria-valuemin"?: number;
"aria-valuenow"?: number;
"aria-valuetext"?: string;
callId?: string;
children?: ReactNode;
collapsable?: boolean;
collapsableChildren?: boolean;
focusable?: boolean;
hasTVPreferredFocus?: boolean;
hitSlop?: null | number | Insets;
id?: string;
importantForAccessibility?: "auto" | "yes" | "no" | "no-hide-descendants";
isTVSelectable?: boolean;
mirror?: boolean;
nativeID?: string;
needsOffscreenAlphaCompositing?: boolean;
onAccessibilityAction?: (event: AccessibilityActionEvent) => void;
onAccessibilityEscape?: () => void;
onAccessibilityTap?: () => void;
onLayout?: (event: LayoutChangeEvent) => void;
onMagicTap?: () => void;
onMoveShouldSetResponder?: (event: GestureResponderEvent) => boolean;
onMoveShouldSetResponderCapture?: (event: GestureResponderEvent) => boolean;
onPointerCancel?: (event: PointerEvent) => void;
onPointerCancelCapture?: (event: PointerEvent) => void;
onPointerDown?: (event: PointerEvent) => void;
onPointerDownCapture?: (event: PointerEvent) => void;
onPointerEnter?: (event: PointerEvent) => void;
onPointerEnterCapture?: (event: PointerEvent) => void;
onPointerLeave?: (event: PointerEvent) => void;
onPointerLeaveCapture?: (event: PointerEvent) => void;
onPointerMove?: (event: PointerEvent) => void;
onPointerMoveCapture?: (event: PointerEvent) => void;
onPointerUp?: (event: PointerEvent) => void;
onPointerUpCapture?: (event: PointerEvent) => void;
onResponderEnd?: (event: GestureResponderEvent) => void;
onResponderGrant?: (event: GestureResponderEvent) => void;
onResponderMove?: (event: GestureResponderEvent) => void;
onResponderReject?: (event: GestureResponderEvent) => void;
onResponderRelease?: (event: GestureResponderEvent) => void;
onResponderStart?: (event: GestureResponderEvent) => void;
onResponderTerminate?: (event: GestureResponderEvent) => void;
onResponderTerminationRequest?: (event: GestureResponderEvent) => boolean;
onStartShouldSetResponder?: (event: GestureResponderEvent) => boolean;
onStartShouldSetResponderCapture?: (
event: GestureResponderEvent,
) => boolean;
onTouchCancel?: (event: GestureResponderEvent) => void;
onTouchEnd?: (event: GestureResponderEvent) => void;
onTouchEndCapture?: (event: GestureResponderEvent) => void;
onTouchMove?: (event: GestureResponderEvent) => void;
onTouchStart?: (event: GestureResponderEvent) => void;
pointerEvents?: "none" | "box-none" | "box-only" | "auto";
removeClippedSubviews?: boolean;
renderToHardwareTextureAndroid?: boolean;
resizeMode?: "contain" | "cover" | "center";
role?: Role;
shouldRasterizeIOS?: boolean;
style?: StyleProp<ViewStyle>;
tabIndex?: 0 | -1;
testID?: string;
tvParallaxMagnification?: number;
tvParallaxShiftDistanceX?: number;
tvParallaxShiftDistanceY?: number;
tvParallaxTiltAngle?: number;
viewType: "local" | "remote";
}Hierarchy (View Summary)
- BaseVideoViewProps
- ViewProps
- DirectCallVideoViewProps
Index
+Properties
accessibilityActions? + DirectCallVideoViewProps | @sendbird/calls-react-native Interface DirectCallVideoViewProps
interface DirectCallVideoViewProps {
accessibilityActions?: readonly Readonly<
{ label?: string; name: string },
>[];
accessibilityElementsHidden?: boolean;
accessibilityHint?: string;
accessibilityIgnoresInvertColors?: boolean;
accessibilityLabel?: string;
accessibilityLabelledBy?: string | string[];
accessibilityLanguage?: string;
accessibilityLargeContentTitle?: string;
accessibilityLiveRegion?: "none" | "polite" | "assertive";
accessibilityRole?: AccessibilityRole;
accessibilityShowsLargeContentViewer?: boolean;
accessibilityState?: AccessibilityState;
accessibilityValue?: AccessibilityValue;
accessibilityViewIsModal?: boolean;
accessible?: boolean;
android_zOrderMediaOverlay?: boolean;
"aria-busy"?: boolean;
"aria-checked"?: boolean | "mixed";
"aria-disabled"?: boolean;
"aria-expanded"?: boolean;
"aria-hidden"?: boolean;
"aria-label"?: string;
"aria-labelledby"?: string;
"aria-live"?: "polite" | "assertive" | "off";
"aria-modal"?: boolean;
"aria-selected"?: boolean;
"aria-valuemax"?: number;
"aria-valuemin"?: number;
"aria-valuenow"?: number;
"aria-valuetext"?: string;
callId?: string;
children?: ReactNode;
collapsable?: boolean;
collapsableChildren?: boolean;
focusable?: boolean;
hasTVPreferredFocus?: boolean;
hitSlop?: number | Insets | null;
id?: string;
importantForAccessibility?: "auto" | "yes" | "no" | "no-hide-descendants";
isTVSelectable?: boolean;
mirror?: boolean;
nativeID?: string;
needsOffscreenAlphaCompositing?: boolean;
onAccessibilityAction?: (event: AccessibilityActionEvent) => void;
onAccessibilityEscape?: () => void;
onAccessibilityTap?: () => void;
onLayout?: (event: LayoutChangeEvent) => void;
onMagicTap?: () => void;
onMoveShouldSetResponder?: (event: GestureResponderEvent) => boolean;
onMoveShouldSetResponderCapture?: (event: GestureResponderEvent) => boolean;
onPointerCancel?: (event: PointerEvent) => void;
onPointerCancelCapture?: (event: PointerEvent) => void;
onPointerDown?: (event: PointerEvent) => void;
onPointerDownCapture?: (event: PointerEvent) => void;
onPointerEnter?: (event: PointerEvent) => void;
onPointerEnterCapture?: (event: PointerEvent) => void;
onPointerLeave?: (event: PointerEvent) => void;
onPointerLeaveCapture?: (event: PointerEvent) => void;
onPointerMove?: (event: PointerEvent) => void;
onPointerMoveCapture?: (event: PointerEvent) => void;
onPointerUp?: (event: PointerEvent) => void;
onPointerUpCapture?: (event: PointerEvent) => void;
onResponderEnd?: (event: GestureResponderEvent) => void;
onResponderGrant?: (event: GestureResponderEvent) => void;
onResponderMove?: (event: GestureResponderEvent) => void;
onResponderReject?: (event: GestureResponderEvent) => void;
onResponderRelease?: (event: GestureResponderEvent) => void;
onResponderStart?: (event: GestureResponderEvent) => void;
onResponderTerminate?: (event: GestureResponderEvent) => void;
onResponderTerminationRequest?: (event: GestureResponderEvent) => boolean;
onStartShouldSetResponder?: (event: GestureResponderEvent) => boolean;
onStartShouldSetResponderCapture?: (
event: GestureResponderEvent,
) => boolean;
onTouchCancel?: (event: GestureResponderEvent) => void;
onTouchEnd?: (event: GestureResponderEvent) => void;
onTouchEndCapture?: (event: GestureResponderEvent) => void;
onTouchMove?: (event: GestureResponderEvent) => void;
onTouchStart?: (event: GestureResponderEvent) => void;
pointerEvents?: "none" | "box-none" | "box-only" | "auto";
removeClippedSubviews?: boolean;
renderToHardwareTextureAndroid?: boolean;
resizeMode?: "contain" | "cover" | "center";
role?: Role;
shouldRasterizeIOS?: boolean;
style?: StyleProp<ViewStyle>;
tabIndex?: 0 | -1;
testID?: string;
tvParallaxMagnification?: number;
tvParallaxShiftDistanceX?: number;
tvParallaxShiftDistanceY?: number;
tvParallaxTiltAngle?: number;
viewType: "local" | "remote";
}Hierarchy (View Summary)
- BaseVideoViewProps
- ViewProps
- DirectCallVideoViewProps
Index
Properties
Optionalaccessibleaccessible?: booleanWhen true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
-
Optionalandroid_z Order Media Overlay android_zOrderMediaOverlay?: boolean
Optionalaria-busy "aria-busy"?: booleanalias for accessibilityState
+
Optionalandroid_z Order Media Overlay android_zOrderMediaOverlay?: boolean
Optionalaria-busy "aria-busy"?: booleanalias for accessibilityState
see https://reactnative.dev/docs/accessibility#accessibilitystate
Optionalaria-checked "aria-checked"?: boolean | "mixed"
Optionalaria-disabled "aria-disabled"?: boolean
Optionalaria-expanded "aria-expanded"?: boolean
Optionalaria-hidden "aria-hidden"?: booleanA value indicating whether the accessibility elements contained within this accessibility element are hidden.
@@ -136,7 +136,7 @@ when this view changes. Works for Android API >= 19 only.
Optionalaria-modal "aria-modal"?: boolean
Optionalaria-selected "aria-selected"?: boolean
Optionalaria-valuemax "aria-valuemax"?: number
Optionalaria-valuemin "aria-valuemin"?: number
Optionalaria-valuenow "aria-valuenow"?: number
Optionalaria-valuetext "aria-valuetext"?: string
OptionalcallId callId?: string
Optionalchildrenchildren?: ReactNode
Optionalcollapsablecollapsable?: booleanViews that are only used to layout their children or otherwise don't draw anything +
Optionalaria-modal "aria-modal"?: boolean
Optionalaria-selected "aria-selected"?: boolean
Optionalaria-valuemax "aria-valuemax"?: number
Optionalaria-valuemin "aria-valuemin"?: number
Optionalaria-valuenow "aria-valuenow"?: number
Optionalaria-valuetext "aria-valuetext"?: string
OptionalcallId callId?: string
Optionalchildrenchildren?: ReactNode
Optionalcollapsablecollapsable?: booleanViews that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy.
OptionalcollapsableChildren collapsableChildren?: booleanSetting to false prevents direct children of the view from being removed @@ -145,7 +145,7 @@
Optionalfocusablefocusable?: booleanWhether this
Viewshould be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
OptionalhasTV Preferred Focus hasTVPreferredFocus?: boolean(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.
OptionalhitSlop hitSlop?: null | number | InsetsThis defines how far a touch event can start away from the view. +
OptionalhitSlop hitSlop?: number | Insets | nullThis defines how far a touch event can start away from the view. Typical interface guidelines recommend touch targets that are at least 30 - 40 points/density-independent pixels. If a Touchable view has a height of 20 the touchable height can be extended to 40 with @@ -158,7 +158,7 @@
OptionalisTV Selectable isTVSelectable?: boolean(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.
Optionalmirrormirror?: boolean
OptionalnativeID nativeID?: stringUsed to reference react managed views from native code.
+
Optionalmirrormirror?: boolean
OptionalnativeID nativeID?: stringUsed to reference react managed views from native code.
OptionalneedsOffscreen Alpha Compositing needsOffscreenAlphaCompositing?: booleanWhether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior. The default (false) falls back to drawing the component and its children with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value. @@ -235,7 +235,7 @@
On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
-
OptionalresizeMode resizeMode?: "contain" | "cover" | "center"
Optionalrolerole?: RoleIndicates to accessibility services to treat UI component like a specific role.
+
OptionalresizeMode resizeMode?: "contain" | "cover" | "center"
Optionalrolerole?: RoleIndicates to accessibility services to treat UI component like a specific role.
OptionalshouldRasterize IOS shouldRasterizeIOS?: booleanWhether this view should be rendered as a bitmap before compositing.
On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children; for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view @@ -259,4 +259,4 @@
OptionaltvParallax Tilt Angle tvParallaxTiltAngle?: number(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 0.05.
view
Type viewType: "local" | "remote"diff --git a/docs/interfaces/GroupCallMethods.html b/docs/interfaces/GroupCallMethods.html index 87ecfb2..dd7124f 100644 --- a/docs/interfaces/GroupCallMethods.html +++ b/docs/interfaces/GroupCallMethods.html @@ -1,8 +1,8 @@ - view
Type viewType: "local" | "remote"GroupCallMethods | @sendbird/calls-react-native diff --git a/docs/interfaces/GroupCallVideoViewProps.html b/docs/interfaces/GroupCallVideoViewProps.html index d398db8..b51ce19 100644 --- a/docs/interfaces/GroupCallVideoViewProps.html +++ b/docs/interfaces/GroupCallVideoViewProps.html @@ -1,4 +1,4 @@ -Interface GroupCallMethods
interface GroupCallMethods {
android_selectAudioDevice: (
...args: [device: AudioDeviceType],
) => Promise;
addListener(listener: Partial<RoomListener>): () => void;
deleteAllCustomItems(): Promise<CustomItemUpdateResult>;
deleteCustomItems(
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
enter(...args: [options: EnterParams]): Promise;
exit(...args: []): void;
updateCustomItems(
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
}Hierarchy
- JSGroupCallModule
- JSGroupCallMediaDeviceControl
- GroupCallMethods
Implemented by
Index
Properties
android_select Audio Device + GroupCallMethods | @sendbird/calls-react-native +Interface GroupCallMethods
interface GroupCallMethods {
android_selectAudioDevice: (
...args: [device: AudioDeviceType],
) => Promise;
addListener(listener: Partial<RoomListener>): () => void;
deleteAllCustomItems(): Promise<CustomItemUpdateResult>;
deleteCustomItems(
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
enter(...args: [options: EnterParams]): Promise;
exit(...args: []): void;
updateCustomItems(
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
}Hierarchy
- JSGroupCallModule
- JSGroupCallMediaDeviceControl
- GroupCallMethods
Implemented by
Index
Properties
Methods
Methods
add
Listener
Parameters
- listener: Partial<RoomListener>
Returns () => void
delete
All Custom Items
Returns Promise<CustomItemUpdateResult>
delete
Custom Items
Parameters
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
enter
Parameters
- ...args: [options: EnterParams]
Returns Promise
exit
Parameters
- ...args: []
Returns void
update
Custom Items
Parameters
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
Methods
add
Listener
Parameters
- listener: Partial<RoomListener>
Returns () => void
delete
All Custom Items
Returns Promise<CustomItemUpdateResult>
delete
Custom Items
Parameters
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
enter
Parameters
- ...args: [options: EnterParams]
Returns Promise
exit
Parameters
- ...args: []
Returns void
update
Custom Items
Parameters
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
GroupCallVideoViewProps | @sendbird/calls-react-native + diff --git a/docs/interfaces/RoomProperties.html b/docs/interfaces/RoomProperties.html index e05d285..3c3933c 100644 --- a/docs/interfaces/RoomProperties.html +++ b/docs/interfaces/RoomProperties.html @@ -1,4 +1,4 @@ -Interface GroupCallVideoViewProps
interface GroupCallVideoViewProps {
accessibilityActions?: readonly Readonly<
{ label?: string; name: string },
>[];
accessibilityElementsHidden?: boolean;
accessibilityHint?: string;
accessibilityIgnoresInvertColors?: boolean;
accessibilityLabel?: string;
accessibilityLabelledBy?: string | string[];
accessibilityLanguage?: string;
accessibilityLargeContentTitle?: string;
accessibilityLiveRegion?: "none" | "polite" | "assertive";
accessibilityRole?: AccessibilityRole;
accessibilityShowsLargeContentViewer?: boolean;
accessibilityState?: AccessibilityState;
accessibilityValue?: AccessibilityValue;
accessibilityViewIsModal?: boolean;
accessible?: boolean;
android_zOrderMediaOverlay?: boolean;
"aria-busy"?: boolean;
"aria-checked"?: boolean | "mixed";
"aria-disabled"?: boolean;
"aria-expanded"?: boolean;
"aria-hidden"?: boolean;
"aria-label"?: string;
"aria-labelledby"?: string;
"aria-live"?: "polite" | "assertive" | "off";
"aria-modal"?: boolean;
"aria-selected"?: boolean;
"aria-valuemax"?: number;
"aria-valuemin"?: number;
"aria-valuenow"?: number;
"aria-valuetext"?: string;
children?: ReactNode;
collapsable?: boolean;
collapsableChildren?: boolean;
focusable?: boolean;
hasTVPreferredFocus?: boolean;
hitSlop?: null | number | Insets;
id?: string;
importantForAccessibility?: "auto" | "yes" | "no" | "no-hide-descendants";
isTVSelectable?: boolean;
mirror?: boolean;
nativeID?: string;
needsOffscreenAlphaCompositing?: boolean;
onAccessibilityAction?: (event: AccessibilityActionEvent) => void;
onAccessibilityEscape?: () => void;
onAccessibilityTap?: () => void;
onLayout?: (event: LayoutChangeEvent) => void;
onMagicTap?: () => void;
onMoveShouldSetResponder?: (event: GestureResponderEvent) => boolean;
onMoveShouldSetResponderCapture?: (event: GestureResponderEvent) => boolean;
onPointerCancel?: (event: PointerEvent) => void;
onPointerCancelCapture?: (event: PointerEvent) => void;
onPointerDown?: (event: PointerEvent) => void;
onPointerDownCapture?: (event: PointerEvent) => void;
onPointerEnter?: (event: PointerEvent) => void;
onPointerEnterCapture?: (event: PointerEvent) => void;
onPointerLeave?: (event: PointerEvent) => void;
onPointerLeaveCapture?: (event: PointerEvent) => void;
onPointerMove?: (event: PointerEvent) => void;
onPointerMoveCapture?: (event: PointerEvent) => void;
onPointerUp?: (event: PointerEvent) => void;
onPointerUpCapture?: (event: PointerEvent) => void;
onResponderEnd?: (event: GestureResponderEvent) => void;
onResponderGrant?: (event: GestureResponderEvent) => void;
onResponderMove?: (event: GestureResponderEvent) => void;
onResponderReject?: (event: GestureResponderEvent) => void;
onResponderRelease?: (event: GestureResponderEvent) => void;
onResponderStart?: (event: GestureResponderEvent) => void;
onResponderTerminate?: (event: GestureResponderEvent) => void;
onResponderTerminationRequest?: (event: GestureResponderEvent) => boolean;
onStartShouldSetResponder?: (event: GestureResponderEvent) => boolean;
onStartShouldSetResponderCapture?: (
event: GestureResponderEvent,
) => boolean;
onTouchCancel?: (event: GestureResponderEvent) => void;
onTouchEnd?: (event: GestureResponderEvent) => void;
onTouchEndCapture?: (event: GestureResponderEvent) => void;
onTouchMove?: (event: GestureResponderEvent) => void;
onTouchStart?: (event: GestureResponderEvent) => void;
participant?: Participant;
pointerEvents?: "none" | "box-none" | "box-only" | "auto";
removeClippedSubviews?: boolean;
renderToHardwareTextureAndroid?: boolean;
resizeMode?: "contain" | "cover" | "center";
role?: Role;
roomId?: string;
shouldRasterizeIOS?: boolean;
style?: StyleProp<ViewStyle>;
tabIndex?: 0 | -1;
testID?: string;
tvParallaxMagnification?: number;
tvParallaxShiftDistanceX?: number;
tvParallaxShiftDistanceY?: number;
tvParallaxTiltAngle?: number;
}Hierarchy (View Summary)
- BaseVideoViewProps
- ViewProps
- GroupCallVideoViewProps
Index
Properties
accessibilityActions? + GroupCallVideoViewProps | @sendbird/calls-react-native Interface GroupCallVideoViewProps
interface GroupCallVideoViewProps {
accessibilityActions?: readonly Readonly<
{ label?: string; name: string },
>[];
accessibilityElementsHidden?: boolean;
accessibilityHint?: string;
accessibilityIgnoresInvertColors?: boolean;
accessibilityLabel?: string;
accessibilityLabelledBy?: string | string[];
accessibilityLanguage?: string;
accessibilityLargeContentTitle?: string;
accessibilityLiveRegion?: "none" | "polite" | "assertive";
accessibilityRole?: AccessibilityRole;
accessibilityShowsLargeContentViewer?: boolean;
accessibilityState?: AccessibilityState;
accessibilityValue?: AccessibilityValue;
accessibilityViewIsModal?: boolean;
accessible?: boolean;
android_zOrderMediaOverlay?: boolean;
"aria-busy"?: boolean;
"aria-checked"?: boolean | "mixed";
"aria-disabled"?: boolean;
"aria-expanded"?: boolean;
"aria-hidden"?: boolean;
"aria-label"?: string;
"aria-labelledby"?: string;
"aria-live"?: "polite" | "assertive" | "off";
"aria-modal"?: boolean;
"aria-selected"?: boolean;
"aria-valuemax"?: number;
"aria-valuemin"?: number;
"aria-valuenow"?: number;
"aria-valuetext"?: string;
children?: ReactNode;
collapsable?: boolean;
collapsableChildren?: boolean;
focusable?: boolean;
hasTVPreferredFocus?: boolean;
hitSlop?: number | Insets | null;
id?: string;
importantForAccessibility?: "auto" | "yes" | "no" | "no-hide-descendants";
isTVSelectable?: boolean;
mirror?: boolean;
nativeID?: string;
needsOffscreenAlphaCompositing?: boolean;
onAccessibilityAction?: (event: AccessibilityActionEvent) => void;
onAccessibilityEscape?: () => void;
onAccessibilityTap?: () => void;
onLayout?: (event: LayoutChangeEvent) => void;
onMagicTap?: () => void;
onMoveShouldSetResponder?: (event: GestureResponderEvent) => boolean;
onMoveShouldSetResponderCapture?: (event: GestureResponderEvent) => boolean;
onPointerCancel?: (event: PointerEvent) => void;
onPointerCancelCapture?: (event: PointerEvent) => void;
onPointerDown?: (event: PointerEvent) => void;
onPointerDownCapture?: (event: PointerEvent) => void;
onPointerEnter?: (event: PointerEvent) => void;
onPointerEnterCapture?: (event: PointerEvent) => void;
onPointerLeave?: (event: PointerEvent) => void;
onPointerLeaveCapture?: (event: PointerEvent) => void;
onPointerMove?: (event: PointerEvent) => void;
onPointerMoveCapture?: (event: PointerEvent) => void;
onPointerUp?: (event: PointerEvent) => void;
onPointerUpCapture?: (event: PointerEvent) => void;
onResponderEnd?: (event: GestureResponderEvent) => void;
onResponderGrant?: (event: GestureResponderEvent) => void;
onResponderMove?: (event: GestureResponderEvent) => void;
onResponderReject?: (event: GestureResponderEvent) => void;
onResponderRelease?: (event: GestureResponderEvent) => void;
onResponderStart?: (event: GestureResponderEvent) => void;
onResponderTerminate?: (event: GestureResponderEvent) => void;
onResponderTerminationRequest?: (event: GestureResponderEvent) => boolean;
onStartShouldSetResponder?: (event: GestureResponderEvent) => boolean;
onStartShouldSetResponderCapture?: (
event: GestureResponderEvent,
) => boolean;
onTouchCancel?: (event: GestureResponderEvent) => void;
onTouchEnd?: (event: GestureResponderEvent) => void;
onTouchEndCapture?: (event: GestureResponderEvent) => void;
onTouchMove?: (event: GestureResponderEvent) => void;
onTouchStart?: (event: GestureResponderEvent) => void;
participant?: Participant;
pointerEvents?: "none" | "box-none" | "box-only" | "auto";
removeClippedSubviews?: boolean;
renderToHardwareTextureAndroid?: boolean;
resizeMode?: "contain" | "cover" | "center";
role?: Role;
roomId?: string;
shouldRasterizeIOS?: boolean;
style?: StyleProp<ViewStyle>;
tabIndex?: 0 | -1;
testID?: string;
tvParallaxMagnification?: number;
tvParallaxShiftDistanceX?: number;
tvParallaxShiftDistanceY?: number;
tvParallaxTiltAngle?: number;
}Hierarchy (View Summary)
- BaseVideoViewProps
- ViewProps
- GroupCallVideoViewProps
Index
Properties
Optionalaccessibleaccessible?: booleanWhen true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
-
Optionalandroid_z Order Media Overlay android_zOrderMediaOverlay?: boolean
Optionalaria-busy "aria-busy"?: booleanalias for accessibilityState
+
Optionalandroid_z Order Media Overlay android_zOrderMediaOverlay?: boolean
Optionalaria-busy "aria-busy"?: booleanalias for accessibilityState
see https://reactnative.dev/docs/accessibility#accessibilitystate
Optionalaria-checked "aria-checked"?: boolean | "mixed"
Optionalaria-disabled "aria-disabled"?: boolean
Optionalaria-expanded "aria-expanded"?: boolean
Optionalaria-hidden "aria-hidden"?: booleanA value indicating whether the accessibility elements contained within this accessibility element are hidden.
@@ -145,7 +145,7 @@
Optionalfocusablefocusable?: booleanWhether this
Viewshould be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
OptionalhasTV Preferred Focus hasTVPreferredFocus?: boolean(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.
OptionalhitSlop hitSlop?: null | number | InsetsThis defines how far a touch event can start away from the view. +
OptionalhitSlop hitSlop?: number | Insets | nullThis defines how far a touch event can start away from the view. Typical interface guidelines recommend touch targets that are at least 30 - 40 points/density-independent pixels. If a Touchable view has a height of 20 the touchable height can be extended to 40 with @@ -158,7 +158,7 @@
OptionalisTV Selectable isTVSelectable?: boolean(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.
Optionalmirrormirror?: boolean
OptionalnativeID nativeID?: stringUsed to reference react managed views from native code.
+
Optionalmirrormirror?: boolean
OptionalnativeID nativeID?: stringUsed to reference react managed views from native code.
OptionalneedsOffscreen Alpha Compositing needsOffscreenAlphaCompositing?: booleanWhether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior. The default (false) falls back to drawing the component and its children with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value. @@ -212,7 +212,7 @@ it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
-
OptionalonTouch Cancel onTouchCancel?: (event: GestureResponderEvent) => void
OptionalonTouch End onTouchEnd?: (event: GestureResponderEvent) => void
OptionalonTouch End Capture onTouchEndCapture?: (event: GestureResponderEvent) => void
OptionalonTouch Move onTouchMove?: (event: GestureResponderEvent) => void
OptionalonTouch Start onTouchStart?: (event: GestureResponderEvent) => void
Optionalparticipant
OptionalpointerEvents pointerEvents?: "none" | "box-none" | "box-only" | "auto"In the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:
+
OptionalonTouch Cancel onTouchCancel?: (event: GestureResponderEvent) => void
OptionalonTouch End onTouchEnd?: (event: GestureResponderEvent) => void
OptionalonTouch End Capture onTouchEndCapture?: (event: GestureResponderEvent) => void
OptionalonTouch Move onTouchMove?: (event: GestureResponderEvent) => void
OptionalonTouch Start onTouchStart?: (event: GestureResponderEvent) => void
Optionalparticipant
OptionalpointerEvents pointerEvents?: "none" | "box-none" | "box-only" | "auto"In the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:
.box-none { pointer-events: none; } @@ -235,8 +235,8 @@
On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
-
OptionalresizeMode resizeMode?: "contain" | "cover" | "center"
Optionalrolerole?: RoleIndicates to accessibility services to treat UI component like a specific role.
-
OptionalroomId roomId?: string
OptionalshouldRasterize IOS shouldRasterizeIOS?: booleanWhether this view should be rendered as a bitmap before compositing.
+
OptionalresizeMode resizeMode?: "contain" | "cover" | "center"
Optionalrolerole?: RoleIndicates to accessibility services to treat UI component like a specific role.
+
OptionalroomId roomId?: string
OptionalshouldRasterize IOS shouldRasterizeIOS?: booleanWhether this view should be rendered as a bitmap before compositing.
On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children; for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view and quickly composite it during each frame.
diff --git a/docs/interfaces/NativeCommonModule.html b/docs/interfaces/NativeCommonModule.html index b6de937..876feaf 100644 --- a/docs/interfaces/NativeCommonModule.html +++ b/docs/interfaces/NativeCommonModule.html @@ -1,4 +1,4 @@ -NativeCommonModule | @sendbird/calls-react-native diff --git a/docs/interfaces/NativeDirectCallModule.html b/docs/interfaces/NativeDirectCallModule.html index 8734eed..1e78ea3 100644 --- a/docs/interfaces/NativeDirectCallModule.html +++ b/docs/interfaces/NativeDirectCallModule.html @@ -1,8 +1,8 @@ -Interface NativeCommonModule
interface NativeCommonModule {
applicationId: string;
currentUser: null | User;
addDirectCallSound(type: SoundType, fileName: string): void;
authenticate(authParams: AuthenticateParams): Promise<User>;
createRoom(roomParams: RoomParams): Promise<RoomProperties>;
deauthenticate(): Promise<void>;
deleteAllCustomItems(callId: string): Promise<CustomItemUpdateResult>;
deleteCustomItems(
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
dial(
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
): Promise<DirectCallProperties>;
fetchRoomById(roomId: string): Promise<RoomProperties>;
getCachedRoomById(roomId: string): Promise<null | RoomProperties>;
getCurrentUser(): Promise<null | User>;
getDirectCall(callId: string): Promise<DirectCallProperties>;
getOngoingCalls(): Promise<DirectCallProperties[]>;
handleFirebaseMessageData(data: Record<string, string>): void;
initialize(appId: string): boolean;
registerPushToken(token: string, unique?: boolean): Promise<void>;
registerVoIPPushToken(token: string, unique?: boolean): Promise<void>;
removeDirectCallSound(type: SoundType): void;
routePickerView(): void;
setDirectCallDialingSoundOnWhenSilentOrVibrateMode(enabled: boolean): void;
setLoggerLevel(level: "none" | "error" | "warning" | "info"): void;
unregisterPushToken(token: string): Promise<void>;
unregisterVoIPPushToken(token: string): Promise<void>;
updateCustomItems(
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
}Hierarchy (View Summary)
- NativeCommonModule
Index
Properties
applicationId + NativeCommonModule | @sendbird/calls-react-native +Interface NativeCommonModule
interface NativeCommonModule {
applicationId: string;
currentUser: User | null;
addDirectCallSound(type: SoundType, fileName: string): void;
authenticate(authParams: AuthenticateParams): Promise<User>;
createRoom(roomParams: RoomParams): Promise<RoomProperties>;
deauthenticate(): Promise<void>;
deleteAllCustomItems(callId: string): Promise<CustomItemUpdateResult>;
deleteCustomItems(
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
dial(
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
): Promise<DirectCallProperties>;
fetchRoomById(roomId: string): Promise<RoomProperties>;
getCachedRoomById(roomId: string): Promise<RoomProperties | null>;
getCurrentUser(): Promise<User | null>;
getDirectCall(callId: string): Promise<DirectCallProperties>;
getOngoingCalls(): Promise<DirectCallProperties[]>;
handleFirebaseMessageData(data: Record<string, string>): void;
initialize(appId: string): boolean;
registerPushToken(token: string, unique?: boolean): Promise<void>;
registerVoIPPushToken(token: string, unique?: boolean): Promise<void>;
removeDirectCallSound(type: SoundType): void;
routePickerView(): void;
setDirectCallDialingSoundOnWhenSilentOrVibrateMode(enabled: boolean): void;
setLoggerLevel(level: "none" | "error" | "warning" | "info"): void;
unregisterPushToken(token: string): Promise<void>;
unregisterVoIPPushToken(token: string): Promise<void>;
updateCustomItems(
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
}Hierarchy (View Summary)
- NativeCommonModule
Index
Properties
Methods
addDirect Call Sound authenticate @@ -23,8 +23,8 @@ unregister Push Token unregister Vo IP Push Token update Custom Items -
Methods
add
Direct Call Sound
Parameters
- type: SoundType
- fileName: string
Returns void
authenticate
Parameters
- authParams: AuthenticateParams
Returns Promise<User>
create
Room
Parameters
- roomParams: RoomParams
Returns Promise<RoomProperties>
deauthenticate
Returns Promise<void>
delete
All Custom Items
Parameters
- callId: string
Returns Promise<CustomItemUpdateResult>
delete
Custom Items
Parameters
- callId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
dial
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
): Promise<DirectCallProperties>Parameters
- calleeUserId: string
- isVideoCall: boolean
- options: CallOptions
Returns Promise<DirectCallProperties>
fetch
Room By Id
Parameters
- roomId: string
Returns Promise<RoomProperties>
get
Cached Room By Id
Parameters
- roomId: string
Returns Promise<null | RoomProperties>
get
Current User
Returns Promise<null | User>
get
Direct Call
Parameters
- callId: string
Returns Promise<DirectCallProperties>
get
Ongoing Calls
Returns Promise<DirectCallProperties[]>
handle
Firebase Message Data
initialize
Parameters
- appId: string
Returns boolean
register
Push Token
Parameters
- token: string
Optionalunique: booleanReturns Promise<void>
register
Vo IP Push Token
remove
Direct Call Sound
Parameters
- type: SoundType
Returns void
route
Picker View
set
Direct Call Dialing Sound On When Silent Or Vibrate Mode
Parameters
- enabled: boolean
Returns void
set
Logger Level
Parameters
- level: "none" | "error" | "warning" | "info"
Returns void
unregister
Push Token
Parameters
- token: string
Returns Promise<void>
unregister
Vo IP Push Token
update
Custom Items
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
Methods
add
Direct Call Sound
Parameters
- type: SoundType
- fileName: string
Returns void
authenticate
Parameters
- authParams: AuthenticateParams
Returns Promise<User>
create
Room
Parameters
- roomParams: RoomParams
Returns Promise<RoomProperties>
deauthenticate
Returns Promise<void>
delete
All Custom Items
Parameters
- callId: string
Returns Promise<CustomItemUpdateResult>
delete
Custom Items
Parameters
- callId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
dial
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
): Promise<DirectCallProperties>Parameters
- calleeUserId: string
- isVideoCall: boolean
- options: CallOptions
Returns Promise<DirectCallProperties>
fetch
Room By Id
Parameters
- roomId: string
Returns Promise<RoomProperties>
get
Cached Room By Id
Parameters
- roomId: string
Returns Promise<RoomProperties | null>
get
Current User
Returns Promise<User | null>
get
Direct Call
Parameters
- callId: string
Returns Promise<DirectCallProperties>
get
Ongoing Calls
Returns Promise<DirectCallProperties[]>
handle
Firebase Message Data
initialize
Parameters
- appId: string
Returns boolean
register
Push Token
Parameters
- token: string
Optionalunique: booleanReturns Promise<void>
register
Vo IP Push Token
remove
Direct Call Sound
Parameters
- type: SoundType
Returns void
route
Picker View
set
Direct Call Dialing Sound On When Silent Or Vibrate Mode
Parameters
- enabled: boolean
Returns void
set
Logger Level
Parameters
- level: "none" | "error" | "warning" | "info"
Returns void
unregister
Push Token
Parameters
- token: string
Returns Promise<void>
unregister
Vo IP Push Token
update
Custom Items
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
NativeDirectCallModule | @sendbird/calls-react-native diff --git a/docs/interfaces/NativeGroupCallModule.html b/docs/interfaces/NativeGroupCallModule.html index c9c681e..c874701 100644 --- a/docs/interfaces/NativeGroupCallModule.html +++ b/docs/interfaces/NativeGroupCallModule.html @@ -1,6 +1,6 @@ -Interface NativeDirectCallModule
interface NativeDirectCallModule {
accept(
callId: string,
options: CallOptions,
holdActiveCall: boolean,
): Promise<void>;
directCallDeleteAllCustomItems(
callId: string,
): Promise<CustomItemUpdateResult>;
directCallDeleteCustomItems(
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
directCallUpdateCustomItems(
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
end(callId: string): Promise<void>;
updateLocalVideoView(callId: string, videoViewId: number): void;
updateRemoteVideoView(callId: string, videoViewId: number): void;
}Hierarchy (View Summary)
- NativeDirectCallModule
Index
Methods
accept +NativeDirectCallModule | @sendbird/calls-react-native +Interface NativeDirectCallModule
interface NativeDirectCallModule {
accept(
callId: string,
options: CallOptions,
holdActiveCall: boolean,
): Promise<void>;
directCallDeleteAllCustomItems(
callId: string,
): Promise<CustomItemUpdateResult>;
directCallDeleteCustomItems(
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
directCallUpdateCustomItems(
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
end(callId: string): Promise<void>;
updateLocalVideoView(callId: string, videoViewId: number): void;
updateRemoteVideoView(callId: string, videoViewId: number): void;
}Hierarchy (View Summary)
- NativeDirectCallModule
Methods
accept
Parameters
- callId: string
- options: CallOptions
- holdActiveCall: boolean
Returns Promise<void>
direct
Call Delete All Custom Items
Parameters
- callId: string
Returns Promise<CustomItemUpdateResult>
direct
Call Delete Custom Items
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
direct
Call Update Custom Items
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
end
Parameters
- callId: string
Returns Promise<void>
update
Local Video View
Parameters
- callId: string
- videoViewId: number
Returns void
update
Remote Video View
Parameters
- callId: string
- videoViewId: number
Returns void
Methods
accept
Parameters
- callId: string
- options: CallOptions
- holdActiveCall: boolean
Returns Promise<void>
direct
Call Delete All Custom Items
Parameters
- callId: string
Returns Promise<CustomItemUpdateResult>
direct
Call Delete Custom Items
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
direct
Call Update Custom Items
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
end
Parameters
- callId: string
Returns Promise<void>
update
Local Video View
Parameters
- callId: string
- videoViewId: number
Returns void
update
Remote Video View
Parameters
- callId: string
- videoViewId: number
Returns void
NativeGroupCallModule | @sendbird/calls-react-native diff --git a/docs/interfaces/NativeMediaDeviceControl.html b/docs/interfaces/NativeMediaDeviceControl.html index 910597e..14e17a6 100644 --- a/docs/interfaces/NativeMediaDeviceControl.html +++ b/docs/interfaces/NativeMediaDeviceControl.html @@ -1,4 +1,4 @@ -Interface NativeGroupCallModule
interface NativeGroupCallModule {
enter(roomId: string, options: EnterParams): Promise<void>;
exit(roomId: string): void;
groupCallDeleteAllCustomItems(
roomId: string,
): Promise<CustomItemUpdateResult>;
groupCallDeleteCustomItems(
roomId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
groupCallUpdateCustomItems(
roomId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
}Hierarchy (View Summary)
- NativeGroupCallModule
Index
Methods
enter +NativeGroupCallModule | @sendbird/calls-react-native +Interface NativeGroupCallModule
interface NativeGroupCallModule {
enter(roomId: string, options: EnterParams): Promise<void>;
exit(roomId: string): void;
groupCallDeleteAllCustomItems(
roomId: string,
): Promise<CustomItemUpdateResult>;
groupCallDeleteCustomItems(
roomId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
groupCallUpdateCustomItems(
roomId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
}Hierarchy (View Summary)
- NativeGroupCallModule
Methods
enter
Parameters
- roomId: string
- options: EnterParams
Returns Promise<void>
exit
Parameters
- roomId: string
Returns void
group
Call Delete All Custom Items
Parameters
- roomId: string
Returns Promise<CustomItemUpdateResult>
group
Call Delete Custom Items
roomId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>Parameters
- roomId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
group
Call Update Custom Items
roomId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- roomId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
Methods
enter
Parameters
- roomId: string
- options: EnterParams
Returns Promise<void>
exit
Parameters
- roomId: string
Returns void
group
Call Delete All Custom Items
Parameters
- roomId: string
Returns Promise<CustomItemUpdateResult>
group
Call Delete Custom Items
roomId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>Parameters
- roomId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
group
Call Update Custom Items
roomId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- roomId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
NativeMediaDeviceControl | @sendbird/calls-react-native diff --git a/docs/interfaces/NativeQueries.html b/docs/interfaces/NativeQueries.html index 85b3212..51133f7 100644 --- a/docs/interfaces/NativeQueries.html +++ b/docs/interfaces/NativeQueries.html @@ -1,5 +1,5 @@ -Interface NativeMediaDeviceControl
interface NativeMediaDeviceControl {
muteMicrophone(type: ControllableModuleType, identifier: string): void;
resumeAudioTrack(type: ControllableModuleType, identifier: string): void;
resumeVideoCapturer(type: ControllableModuleType, identifier: string): void;
selectAudioDevice(
type: ControllableModuleType,
identifier: string,
device: AudioDeviceType,
): Promise<void>;
selectVideoDevice(
type: ControllableModuleType,
identifier: string,
device: VideoDevice,
): Promise<void>;
startVideo(type: ControllableModuleType, identifier: string): void;
stopVideo(type: ControllableModuleType, identifier: string): void;
switchCamera(
type: ControllableModuleType,
identifier: string,
): Promise<void>;
unmuteMicrophone(type: ControllableModuleType, identifier: string): void;
}Hierarchy (View Summary)
- NativeMediaDeviceControl
Index
Methods
muteMicrophone + NativeMediaDeviceControl | @sendbird/calls-react-native +Interface NativeMediaDeviceControl
interface NativeMediaDeviceControl {
muteMicrophone(type: ControllableModuleType, identifier: string): void;
resumeAudioTrack(type: ControllableModuleType, identifier: string): void;
resumeVideoCapturer(type: ControllableModuleType, identifier: string): void;
selectAudioDevice(
type: ControllableModuleType,
identifier: string,
device: AudioDeviceType,
): Promise<void>;
selectVideoDevice(
type: ControllableModuleType,
identifier: string,
device: VideoDevice,
): Promise<void>;
startVideo(type: ControllableModuleType, identifier: string): void;
stopVideo(type: ControllableModuleType, identifier: string): void;
switchCamera(
type: ControllableModuleType,
identifier: string,
): Promise<void>;
unmuteMicrophone(type: ControllableModuleType, identifier: string): void;
}Hierarchy (View Summary)
- NativeMediaDeviceControl
Index
Methods
Methods
mute
Microphone
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
resume
Audio Track
resume
Video Capturer
select
Audio Device
type: ControllableModuleType,
identifier: string,
device: AudioDeviceType,
): Promise<void>Parameters
- type: ControllableModuleType
- identifier: string
- device: AudioDeviceType
Returns Promise<void>
select
Video Device
type: ControllableModuleType,
identifier: string,
device: VideoDevice,
): Promise<void>Parameters
- type: ControllableModuleType
- identifier: string
- device: VideoDevice
Returns Promise<void>
start
Video
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
stop
Video
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
switch
Camera
Parameters
- type: ControllableModuleType
- identifier: string
Returns Promise<void>
unmute
Microphone
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
Methods
mute
Microphone
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
resume
Audio Track
resume
Video Capturer
select
Audio Device
type: ControllableModuleType,
identifier: string,
device: AudioDeviceType,
): Promise<void>Parameters
- type: ControllableModuleType
- identifier: string
- device: AudioDeviceType
Returns Promise<void>
select
Video Device
type: ControllableModuleType,
identifier: string,
device: VideoDevice,
): Promise<void>Parameters
- type: ControllableModuleType
- identifier: string
- device: VideoDevice
Returns Promise<void>
start
Video
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
stop
Video
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
switch
Camera
Parameters
- type: ControllableModuleType
- identifier: string
Returns Promise<void>
unmute
Microphone
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
NativeQueries | @sendbird/calls-react-native diff --git a/docs/interfaces/ParticipantProperties.html b/docs/interfaces/ParticipantProperties.html index 7c2287b..d107468 100644 --- a/docs/interfaces/ParticipantProperties.html +++ b/docs/interfaces/ParticipantProperties.html @@ -1,4 +1,4 @@ -Interface NativeQueries
interface NativeQueries {
createDirectCallLogListQuery: NativeQueryCreator<
DirectCallLogQueryParams,
>;
createRoomListQuery: NativeQueryCreator<RoomListQueryParams>;
queryNext<T extends NativeQueryType>(
key: `native#${string}`,
type: T,
): NativeQueryResult<
T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties,
>;
queryRelease(key: `native#${string}`): void;
}Hierarchy (View Summary)
- NativeQueries
Index
Properties
createDirect Call Log List Query + NativeQueries | @sendbird/calls-react-native +Interface NativeQueries
interface NativeQueries {
createDirectCallLogListQuery: NativeQueryCreator<
DirectCallLogQueryParams,
>;
createRoomListQuery: NativeQueryCreator<RoomListQueryParams>;
queryNext<T extends NativeQueryType>(
key: `native#${string}`,
type: T,
): NativeQueryResult<
T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties,
>;
queryRelease(key: `native#${string}`): void;
}Hierarchy (View Summary)
- NativeQueries
Index
Properties
Methods
Methods
query
Next
key: `native#${string}`,
type: T,
): NativeQueryResult<
T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties,
>Type Parameters
- T extends NativeQueryType
Parameters
- key: `native#${string}`
- type: T
Returns NativeQueryResult<T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties>
query
Release
Parameters
- key: `native#${string}`
Returns void
Methods
query
Next
key: `native#${string}`,
type: T,
): NativeQueryResult<
T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties,
>Type Parameters
- T extends NativeQueryType
Parameters
- key: `native#${string}`
- type: T
Returns NativeQueryResult<T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties>
query
Release
Parameters
- key: `native#${string}`
Returns void
ParticipantProperties | @sendbird/calls-react-native diff --git a/docs/interfaces/Query.html b/docs/interfaces/Query.html index 1ee9d65..03f285c 100644 --- a/docs/interfaces/Query.html +++ b/docs/interfaces/Query.html @@ -1,5 +1,5 @@ -Interface ParticipantProperties
interface ParticipantProperties {
duration: number;
enteredAt: number;
exitedAt: number;
isAudioEnabled: boolean;
isVideoEnabled: boolean;
participantId: string;
state: ParticipantState;
updatedAt: number;
user: User;
}Implemented by
Index
Properties
duration +ParticipantProperties | @sendbird/calls-react-native +Interface ParticipantProperties
interface ParticipantProperties {
duration: number;
enteredAt: number;
exitedAt: number;
isAudioEnabled: boolean;
isVideoEnabled: boolean;
participantId: string;
state: ParticipantState;
updatedAt: number;
user: User;
}Implemented by
Query | @sendbird/calls-react-native diff --git a/docs/interfaces/RoomListener.html b/docs/interfaces/RoomListener.html index c78a3e4..24499a9 100644 --- a/docs/interfaces/RoomListener.html +++ b/docs/interfaces/RoomListener.html @@ -1,4 +1,4 @@ -Interface Query
Index
Properties
RoomListener | @sendbird/calls-react-native Interface RoomListener
interface RoomListener {
onAudioDeviceChanged: (info: AudioDeviceChangedInfo) => void;
onCustomItemsDeleted: (deletedKeys: string[]) => void;
onCustomItemsUpdated: (updatedKeys: string[]) => void;
onDeleted: () => void;
onError: (e: SendbirdError, participant: null | Participant) => void;
onLocalParticipantDisconnected: (participant: Participant) => void;
onLocalParticipantReconnected: (participant: Participant) => void;
onPropertyUpdatedManually: (room: RoomProperties) => void;
onRemoteAudioSettingsChanged: (participant: Participant) => void;
onRemoteParticipantEntered: (participant: Participant) => void;
onRemoteParticipantExited: (participant: Participant) => void;
onRemoteParticipantStreamStarted: (participant: Participant) => void;
onRemoteVideoSettingsChanged: (participant: Participant) => void;
}
Index
Properties
onAudio Device Changed + RoomListener | @sendbird/calls-react-native Interface RoomListener
interface RoomListener {
onAudioDeviceChanged: (info: AudioDeviceChangedInfo) => void;
onCustomItemsDeleted: (deletedKeys: string[]) => void;
onCustomItemsUpdated: (updatedKeys: string[]) => void;
onDeleted: () => void;
onError: (e: SendbirdError, participant: Participant | null) => void;
onLocalParticipantDisconnected: (participant: Participant) => void;
onLocalParticipantReconnected: (participant: Participant) => void;
onPropertyUpdatedManually: (room: RoomProperties) => void;
onRemoteAudioSettingsChanged: (participant: Participant) => void;
onRemoteParticipantEntered: (participant: Participant) => void;
onRemoteParticipantExited: (participant: Participant) => void;
onRemoteParticipantStreamStarted: (participant: Participant) => void;
onRemoteVideoSettingsChanged: (participant: Participant) => void;
}
Index
Properties
onAudio Device Changed on Custom Items Deleted on Custom Items Updated on Deleted @@ -16,29 +16,29 @@ See also: AVAudioSession.setPreferredInput https://developer.apple.com/documentation/avfaudio/avaudiosession/1616491-setpreferredinput See also: AVRoutePickerView https://developer.apple.com/documentation/avkit/avroutepickerview on
Custom Items Deleted onCustomItemsDeleted: (deletedKeys: string[]) => voidCalled when the custom items of the call are deleted.
+on
Custom Items Deleted onCustomItemsDeleted: (deletedKeys: string[]) => voidCalled when the custom items of the call are deleted.
on
Custom Items Updated onCustomItemsUpdated: (updatedKeys: string[]) => voidCalled when the custom items of the call are updated.
+on
Custom Items Updated onCustomItemsUpdated: (updatedKeys: string[]) => voidCalled when the custom items of the call are updated.
on
Deleted onDeleted: () => voidCalled when GroupCall Room is deleted.
+on
Deleted onDeleted: () => voidCalled when GroupCall Room is deleted.
on
Error Called when a participant stream is lost due to reconnection failure.
+on
Error Called when a participant stream is lost due to reconnection failure.
on
Local Participant Disconnected Called when the local participant's connection with the server has been interrupted.
+on
Local Participant Disconnected Called when the local participant's connection with the server has been interrupted.
on
Local Participant Reconnected Called when the local participant's connection with the server has been established.
+on
Local Participant Reconnected Called when the local participant's connection with the server has been established.
on
Property Updated Manually Called when the update properties internally on Javascript side
+on
Property Updated Manually Called when the update properties internally on Javascript side
on
Remote Audio Settings Changed Called when a remote participant changed audio settings.
+on
Remote Audio Settings Changed Called when a remote participant changed audio settings.
on
Remote Participant Entered Called when a remote participant entered the room.
+on
Remote Participant Entered Called when a remote participant entered the room.
on
Remote Participant Exited Called when a remote participant exited the room.
+on
Remote Participant Exited Called when a remote participant exited the room.
on
Remote Participant Stream Started Called when a remote participant starts to send a stream.
+on
Remote Participant Stream Started Called when a remote participant starts to send a stream.
on
Remote Video Settings Changed Called when a remote participant changed video settings.
+on
Remote Video Settings Changed Called when a remote participant changed video settings.
RoomProperties | @sendbird/calls-react-native Interface RoomProperties
interface RoomProperties {
android_availableAudioDevices: AudioDeviceType[];
android_currentAudioDevice: null | AudioDeviceType;
createdAt: number;
createdBy: string;
customItems: Record<string, string>;
localParticipant: null | ParticipantProperties;
participants: ParticipantProperties[];
remoteParticipants: ParticipantProperties[];
roomId: string;
state: RoomState;
type: RoomType;
}Implemented by
Index
Properties
android_available Audio Devices + RoomProperties | @sendbird/calls-react-native Interface RoomProperties
interface RoomProperties {
android_availableAudioDevices: AudioDeviceType[];
android_currentAudioDevice: AudioDeviceType | null;
createdAt: number;
createdBy: string;
customItems: Record<string, string>;
localParticipant: ParticipantProperties | null;
participants: ParticipantProperties[];
remoteParticipants: ParticipantProperties[];
roomId: string;
state: RoomState;
type: RoomType;
}Implemented by
Index
Properties
android_
current Audio Device Gets current audio device.
created
At createdAt: numberGets createdAt that is a timestamp of creating the room.
+created
At createdAt: numberGets createdAt that is a timestamp of creating the room.
created
By createdBy: stringGets user ID created the room.
+created
By createdBy: stringGets user ID created the room.
custom
Items customItems: Record<string, string>Gets custom items of this Room instance.
+custom
Items customItems: Record<string, string>Gets custom items of this Room instance.
local
Participant Gets the local participant.
+local
Participant Gets the local participant.
participants
Gets a list of participants who entered the room.
+participants
Gets a list of participants who entered the room.
remote
Participants Gets a list of remote participants who entered the room.
+remote
Participants Gets a list of remote participants who entered the room.
room
Id roomId: stringGets room ID.
+room
Id roomId: stringGets room ID.
state
Gets state of room.
+state
Gets state of room.
type
Gets type of room.
++ diff --git a/docs/interfaces/SendbirdCallListener.html b/docs/interfaces/SendbirdCallListener.html index 1fdc981..5ef222e 100644 --- a/docs/interfaces/SendbirdCallListener.html +++ b/docs/interfaces/SendbirdCallListener.html @@ -1,4 +1,4 @@ - type
Gets type of room.
SendbirdCallListener | @sendbird/calls-react-native diff --git a/docs/interfaces/SendbirdCallsJavascriptSpec.html b/docs/interfaces/SendbirdCallsJavascriptSpec.html index c9a3881..83b30a4 100644 --- a/docs/interfaces/SendbirdCallsJavascriptSpec.html +++ b/docs/interfaces/SendbirdCallsJavascriptSpec.html @@ -1,4 +1,4 @@ -Interface SendbirdCallListener
Index
Properties
onRinging + SendbirdCallListener | @sendbird/calls-react-native + SendbirdCallsJavascriptSpec | @sendbird/calls-react-native diff --git a/docs/interfaces/SendbirdCallsNativeSpec.html b/docs/interfaces/SendbirdCallsNativeSpec.html index e6d81b9..b118e63 100644 --- a/docs/interfaces/SendbirdCallsNativeSpec.html +++ b/docs/interfaces/SendbirdCallsNativeSpec.html @@ -1,4 +1,4 @@ -Interface SendbirdCallsJavascriptSpec
interface SendbirdCallsJavascriptSpec {
addDirectCallSound: (type: SoundType, fileName: string) => void;
android_handleFirebaseMessageData: (data: Record<string, string>) => void;
applicationId: string;
authenticate: (authParams: AuthenticateParams) => Promise<User>;
createRoom: (roomParams: RoomParams) => Promise<RoomProperties>;
currentUser: null | User;
deauthenticate: () => Promise<void>;
deleteAllCustomItems: (callId: string) => Promise<CustomItemUpdateResult>;
deleteCustomItems: (
callId: string,
customItemKeys: string[],
) => Promise<CustomItemUpdateResult>;
dial: (
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
) => Promise<DirectCallProperties>;
fetchRoomById: (roomId: string) => Promise<RoomProperties>;
getCachedRoomById: (roomId: string) => Promise<null | RoomProperties>;
getCurrentUser: () => Promise<null | User>;
getDirectCall: (callId: string) => Promise<DirectCallProperties>;
getOngoingCalls: () => Promise<DirectCallProperties[]>;
initialize: (appId: string) => boolean;
ios_registerVoIPPushToken: (
token: string,
unique?: boolean,
) => Promise<void>;
ios_routePickerView: () => void;
ios_unregisterVoIPPushToken: (token: string) => Promise<void>;
registerPushToken: (token: string, unique?: boolean) => Promise<void>;
removeDirectCallSound: (type: SoundType) => void;
setDirectCallDialingSoundOnWhenSilentOrVibrateMode: (
enabled: boolean,
) => void;
setLoggerLevel: (level: "none" | "error" | "warning" | "info") => void;
unregisterPushToken: (token: string) => Promise<void>;
updateCustomItems: (
callId: string,
customItems: Record<string, string>,
) => Promise<CustomItemUpdateResult>;
createDirectCallLogListQuery(
params: DirectCallLogQueryParams,
): Promise<BridgedQuery<DIRECT_CALL_LOG>>;
createRoomListQuery(
params: RoomListQueryParams,
): Promise<BridgedQuery<ROOM_LIST>>;
setListener(listener: SendbirdCallListener): void;
}Hierarchy
- PlatformSpecificInterface
- SendbirdCallsJavascriptSpec
Implemented by
Index
Properties
addDirect Call Sound + SendbirdCallsJavascriptSpec | @sendbird/calls-react-native +Interface SendbirdCallsJavascriptSpec
interface SendbirdCallsJavascriptSpec {
addDirectCallSound: (type: SoundType, fileName: string) => void;
android_handleFirebaseMessageData: (data: Record<string, string>) => void;
applicationId: string;
authenticate: (authParams: AuthenticateParams) => Promise<User>;
createRoom: (roomParams: RoomParams) => Promise<RoomProperties>;
currentUser: User | null;
deauthenticate: () => Promise<void>;
deleteAllCustomItems: (callId: string) => Promise<CustomItemUpdateResult>;
deleteCustomItems: (
callId: string,
customItemKeys: string[],
) => Promise<CustomItemUpdateResult>;
dial: (
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
) => Promise<DirectCallProperties>;
fetchRoomById: (roomId: string) => Promise<RoomProperties>;
getCachedRoomById: (roomId: string) => Promise<RoomProperties | null>;
getCurrentUser: () => Promise<User | null>;
getDirectCall: (callId: string) => Promise<DirectCallProperties>;
getOngoingCalls: () => Promise<DirectCallProperties[]>;
initialize: (appId: string) => boolean;
ios_registerVoIPPushToken: (
token: string,
unique?: boolean,
) => Promise<void>;
ios_routePickerView: () => void;
ios_unregisterVoIPPushToken: (token: string) => Promise<void>;
registerPushToken: (token: string, unique?: boolean) => Promise<void>;
removeDirectCallSound: (type: SoundType) => void;
setDirectCallDialingSoundOnWhenSilentOrVibrateMode: (
enabled: boolean,
) => void;
setLoggerLevel: (level: "none" | "error" | "warning" | "info") => void;
unregisterPushToken: (token: string) => Promise<void>;
updateCustomItems: (
callId: string,
customItems: Record<string, string>,
) => Promise<CustomItemUpdateResult>;
createDirectCallLogListQuery(
params: DirectCallLogQueryParams,
): Promise<BridgedQuery<DIRECT_CALL_LOG>>;
createRoomListQuery(
params: RoomListQueryParams,
): Promise<BridgedQuery<ROOM_LIST>>;
setListener(listener: SendbirdCallListener): void;
}Hierarchy
- PlatformSpecificInterface
- SendbirdCallsJavascriptSpec
Implemented by
Index
Properties
Properties
add
Direct Call Sound android_
handle Firebase Message Data android_handleFirebaseMessageData: (data: Record<string, string>) => voidapplication
Id applicationId: stringauthenticate
create
Room current
User deauthenticate
deauthenticate: () => Promise<void>delete
All Custom Items delete
Custom Items dial
dial: (
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
) => Promise<DirectCallProperties>fetch
Room By Id get
Cached Room By Id get
Current User get
Direct Call get
Ongoing Calls initialize
initialize: (appId: string) => booleanios_
register Vo IP Push Token ios_registerVoIPPushToken: (token: string, unique?: boolean) => Promise<void>application
Id applicationId: stringauthenticate
create
Room current
User deauthenticate
deauthenticate: () => Promise<void>delete
All Custom Items delete
Custom Items dial
dial: (
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
) => Promise<DirectCallProperties>fetch
Room By Id get
Cached Room By Id get
Current User get
Direct Call get
Ongoing Calls initialize
initialize: (appId: string) => booleanios_
register Vo IP Push Token ios_registerVoIPPushToken: (token: string, unique?: boolean) => Promise<void>ios_
route Picker View ios_routePickerView: () => voidios_
unregister Vo IP Push Token ios_unregisterVoIPPushToken: (token: string) => Promise<void>register
Push Token registerPushToken: (token: string, unique?: boolean) => Promise<void>remove
Direct Call Sound set
Direct Call Dialing Sound On When Silent Or Vibrate Mode setDirectCallDialingSoundOnWhenSilentOrVibrateMode: (enabled: boolean) => voidset
Logger Level setLoggerLevel: (level: "none" | "error" | "warning" | "info") => voidunregister
Push Token unregisterPushToken: (token: string) => Promise<void>update
Custom Items updateCustomItems: (
callId: string,
customItems: Record<string, string>,
) => Promise<CustomItemUpdateResult>
Methods
create
Direct Call Log List Query
params: DirectCallLogQueryParams,
): Promise<BridgedQuery<DIRECT_CALL_LOG>>create
Room List Query
Parameters
- params: RoomListQueryParams
Returns Promise<BridgedQuery<ROOM_LIST>>
set
Listener
Parameters
- params: DirectCallLogQueryParams
Returns Promise<BridgedQuery<DIRECT_CALL_LOG>>
create
Room List Query
Parameters
- params: RoomListQueryParams
Returns Promise<BridgedQuery<ROOM_LIST>>
set
Listener
SendbirdCallsNativeSpec | @sendbird/calls-react-native Interface SendbirdCallsNativeSpec
interface SendbirdCallsNativeSpec {
addListener: (eventType: string) => void;
applicationId: string;
createDirectCallLogListQuery: NativeQueryCreator<DirectCallLogQueryParams>;
createRoomListQuery: NativeQueryCreator<RoomListQueryParams>;
currentUser: null | User;
removeListeners: (count: number) => void;
accept(
callId: string,
options: CallOptions,
holdActiveCall: boolean,
): Promise<void>;
addDirectCallSound(type: SoundType, fileName: string): void;
authenticate(authParams: AuthenticateParams): Promise<User>;
createRoom(roomParams: RoomParams): Promise<RoomProperties>;
deauthenticate(): Promise<void>;
deleteAllCustomItems(callId: string): Promise<CustomItemUpdateResult>;
deleteCustomItems(
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
dial(
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
): Promise<DirectCallProperties>;
directCallDeleteAllCustomItems(
callId: string,
): Promise<CustomItemUpdateResult>;
directCallDeleteCustomItems(
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
directCallUpdateCustomItems(
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
end(callId: string): Promise<void>;
enter(roomId: string, options: EnterParams): Promise<void>;
exit(roomId: string): void;
fetchRoomById(roomId: string): Promise<RoomProperties>;
getCachedRoomById(roomId: string): Promise<null | RoomProperties>;
getConstants?(): {};
getCurrentUser(): Promise<null | User>;
getDirectCall(callId: string): Promise<DirectCallProperties>;
getOngoingCalls(): Promise<DirectCallProperties[]>;
groupCallDeleteAllCustomItems(
roomId: string,
): Promise<CustomItemUpdateResult>;
groupCallDeleteCustomItems(
roomId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
groupCallUpdateCustomItems(
roomId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
handleFirebaseMessageData(data: Record<string, string>): void;
initialize(appId: string): boolean;
muteMicrophone(type: ControllableModuleType, identifier: string): void;
queryNext<T extends NativeQueryType>(
key: `native#${string}`,
type: T,
): NativeQueryResult<
T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties,
>;
queryRelease(key: `native#${string}`): void;
registerPushToken(token: string, unique?: boolean): Promise<void>;
registerVoIPPushToken(token: string, unique?: boolean): Promise<void>;
removeDirectCallSound(type: SoundType): void;
resumeAudioTrack(type: ControllableModuleType, identifier: string): void;
resumeVideoCapturer(type: ControllableModuleType, identifier: string): void;
routePickerView(): void;
selectAudioDevice(
type: ControllableModuleType,
identifier: string,
device: AudioDeviceType,
): Promise<void>;
selectVideoDevice(
type: ControllableModuleType,
identifier: string,
device: VideoDevice,
): Promise<void>;
setDirectCallDialingSoundOnWhenSilentOrVibrateMode(enabled: boolean): void;
setLoggerLevel(level: "none" | "error" | "warning" | "info"): void;
startVideo(type: ControllableModuleType, identifier: string): void;
stopVideo(type: ControllableModuleType, identifier: string): void;
switchCamera(
type: ControllableModuleType,
identifier: string,
): Promise<void>;
unmuteMicrophone(type: ControllableModuleType, identifier: string): void;
unregisterPushToken(token: string): Promise<void>;
unregisterVoIPPushToken(token: string): Promise<void>;
updateCustomItems(
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
updateLocalVideoView(callId: string, videoViewId: number): void;
updateRemoteVideoView(callId: string, videoViewId: number): void;
}Hierarchy (View Summary)
- NativeModuleInterface
- NativeQueries
- NativeCommonModule
- NativeDirectCallModule
- NativeGroupCallModule
- NativeMediaDeviceControl
- SendbirdCallsNativeSpec
Index
+Properties
addListener + SendbirdCallsNativeSpec | @sendbird/calls-react-native Interface SendbirdCallsNativeSpec
interface SendbirdCallsNativeSpec {
addListener: (eventType: string) => void;
applicationId: string;
createDirectCallLogListQuery: NativeQueryCreator<DirectCallLogQueryParams>;
createRoomListQuery: NativeQueryCreator<RoomListQueryParams>;
currentUser: User | null;
removeListeners: (count: number) => void;
accept(
callId: string,
options: CallOptions,
holdActiveCall: boolean,
): Promise<void>;
addDirectCallSound(type: SoundType, fileName: string): void;
authenticate(authParams: AuthenticateParams): Promise<User>;
createRoom(roomParams: RoomParams): Promise<RoomProperties>;
deauthenticate(): Promise<void>;
deleteAllCustomItems(callId: string): Promise<CustomItemUpdateResult>;
deleteCustomItems(
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
dial(
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
): Promise<DirectCallProperties>;
directCallDeleteAllCustomItems(
callId: string,
): Promise<CustomItemUpdateResult>;
directCallDeleteCustomItems(
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
directCallUpdateCustomItems(
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
end(callId: string): Promise<void>;
enter(roomId: string, options: EnterParams): Promise<void>;
exit(roomId: string): void;
fetchRoomById(roomId: string): Promise<RoomProperties>;
getCachedRoomById(roomId: string): Promise<RoomProperties | null>;
getConstants?(): {};
getCurrentUser(): Promise<User | null>;
getDirectCall(callId: string): Promise<DirectCallProperties>;
getOngoingCalls(): Promise<DirectCallProperties[]>;
groupCallDeleteAllCustomItems(
roomId: string,
): Promise<CustomItemUpdateResult>;
groupCallDeleteCustomItems(
roomId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>;
groupCallUpdateCustomItems(
roomId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
handleFirebaseMessageData(data: Record<string, string>): void;
initialize(appId: string): boolean;
muteMicrophone(type: ControllableModuleType, identifier: string): void;
queryNext<T extends NativeQueryType>(
key: `native#${string}`,
type: T,
): NativeQueryResult<
T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties,
>;
queryRelease(key: `native#${string}`): void;
registerPushToken(token: string, unique?: boolean): Promise<void>;
registerVoIPPushToken(token: string, unique?: boolean): Promise<void>;
removeDirectCallSound(type: SoundType): void;
resumeAudioTrack(type: ControllableModuleType, identifier: string): void;
resumeVideoCapturer(type: ControllableModuleType, identifier: string): void;
routePickerView(): void;
selectAudioDevice(
type: ControllableModuleType,
identifier: string,
device: AudioDeviceType,
): Promise<void>;
selectVideoDevice(
type: ControllableModuleType,
identifier: string,
device: VideoDevice,
): Promise<void>;
setDirectCallDialingSoundOnWhenSilentOrVibrateMode(enabled: boolean): void;
setLoggerLevel(level: "none" | "error" | "warning" | "info"): void;
startVideo(type: ControllableModuleType, identifier: string): void;
stopVideo(type: ControllableModuleType, identifier: string): void;
switchCamera(
type: ControllableModuleType,
identifier: string,
): Promise<void>;
unmuteMicrophone(type: ControllableModuleType, identifier: string): void;
unregisterPushToken(token: string): Promise<void>;
unregisterVoIPPushToken(token: string): Promise<void>;
updateCustomItems(
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>;
updateLocalVideoView(callId: string, videoViewId: number): void;
updateRemoteVideoView(callId: string, videoViewId: number): void;
}Hierarchy (View Summary)
- NativeModuleInterface
- NativeQueries
- NativeCommonModule
- NativeDirectCallModule
- NativeGroupCallModule
- NativeMediaDeviceControl
- SendbirdCallsNativeSpec
Index
Properties
addListener application Id create Direct Call Log List Query create Room List Query @@ -53,15 +53,15 @@ update Remote Video View
Properties
add
Listener addListener: (eventType: string) => voidAdd the provided eventType as an active listener
Type Declaration
- (eventType: string): void
Parameters
- eventType: string
name of the event for which we are registering listener
-Returns void
application
Id applicationId: stringcreate
Direct Call Log List Query create
Room List Query current
User remove
Listeners removeListeners: (count: number) => voidRemove a specified number of events. There are no eventTypes in this case, as +
Returns void
application
Id applicationId: stringcreate
Direct Call Log List Query create
Room List Query current
User remove
Listeners removeListeners: (count: number) => voidRemove a specified number of events. There are no eventTypes in this case, as the native side doesn't remove the name, but only manages a counter of total listeners
Type Declaration
- (count: number): void
Parameters
- count: number
number of listeners to remove (of any type)
-Returns void
Methods
accept
Parameters
- callId: string
- options: CallOptions
- holdActiveCall: boolean
Returns Promise<void>
add
Direct Call Sound
Parameters
- type: SoundType
- fileName: string
Returns void
authenticate
Parameters
- authParams: AuthenticateParams
Returns Promise<User>
create
Room
Parameters
- roomParams: RoomParams
Returns Promise<RoomProperties>
deauthenticate
Returns Promise<void>
delete
All Custom Items
Parameters
- callId: string
Returns Promise<CustomItemUpdateResult>
delete
Custom Items
Parameters
- callId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
dial
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
): Promise<DirectCallProperties>Parameters
- calleeUserId: string
- isVideoCall: boolean
- options: CallOptions
Returns Promise<DirectCallProperties>
direct
Call Delete All Custom Items
Parameters
- callId: string
Returns Promise<CustomItemUpdateResult>
direct
Call Delete Custom Items
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
direct
Call Update Custom Items
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
end
Parameters
- callId: string
Returns Promise<void>
enter
Parameters
- roomId: string
- options: EnterParams
Returns Promise<void>
exit
Parameters
- roomId: string
Returns void
fetch
Room By Id
Parameters
- roomId: string
Returns Promise<RoomProperties>
get
Cached Room By Id
Parameters
- roomId: string
Returns Promise<null | RoomProperties>
OptionalgetConstants
Returns {}
get
Current User
Returns Promise<null | User>
get
Direct Call
Parameters
- callId: string
Returns Promise<DirectCallProperties>
get
Ongoing Calls
Returns Promise<DirectCallProperties[]>
group
Call Delete All Custom Items
Parameters
- roomId: string
Returns Promise<CustomItemUpdateResult>
group
Call Delete Custom Items
roomId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>Parameters
- roomId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
group
Call Update Custom Items
roomId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- roomId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
handle
Firebase Message Data
initialize
Parameters
- appId: string
Returns boolean
mute
Microphone
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
query
Next
key: `native#${string}`,
type: T,
): NativeQueryResult<
T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties,
>Type Parameters
- T extends NativeQueryType
Parameters
- key: `native#${string}`
- type: T
Returns NativeQueryResult<T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties>
query
Release
Parameters
- key: `native#${string}`
Returns void
register
Push Token
Parameters
- token: string
Optionalunique: booleanReturns Promise<void>
register
Vo IP Push Token
remove
Direct Call Sound
Parameters
- type: SoundType
Returns void
resume
Audio Track
resume
Video Capturer
route
Picker View
select
Audio Device
type: ControllableModuleType,
identifier: string,
device: AudioDeviceType,
): Promise<void>Parameters
- type: ControllableModuleType
- identifier: string
- device: AudioDeviceType
Returns Promise<void>
select
Video Device
type: ControllableModuleType,
identifier: string,
device: VideoDevice,
): Promise<void>Parameters
- type: ControllableModuleType
- identifier: string
- device: VideoDevice
Returns Promise<void>
set
Direct Call Dialing Sound On When Silent Or Vibrate Mode
Parameters
- enabled: boolean
Returns void
set
Logger Level
Parameters
- level: "none" | "error" | "warning" | "info"
Returns void
start
Video
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
stop
Video
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
switch
Camera
Parameters
- type: ControllableModuleType
- identifier: string
Returns Promise<void>
unmute
Microphone
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
unregister
Push Token
Parameters
- token: string
Returns Promise<void>
unregister
Vo IP Push Token
update
Custom Items
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
update
Local Video View
Parameters
- callId: string
- videoViewId: number
Returns void
update
Remote Video View
Parameters
- callId: string
- videoViewId: number
Returns void
Returns void
diff --git a/docs/interfaces/User.html b/docs/interfaces/User.html index f774c72..9df64e5 100644 --- a/docs/interfaces/User.html +++ b/docs/interfaces/User.html @@ -1,6 +1,6 @@ -
Methods
accept
Parameters
- callId: string
- options: CallOptions
- holdActiveCall: boolean
Returns Promise<void>
add
Direct Call Sound
Parameters
- type: SoundType
- fileName: string
Returns void
authenticate
Parameters
- authParams: AuthenticateParams
Returns Promise<User>
create
Room
Parameters
- roomParams: RoomParams
Returns Promise<RoomProperties>
deauthenticate
Returns Promise<void>
delete
All Custom Items
Parameters
- callId: string
Returns Promise<CustomItemUpdateResult>
delete
Custom Items
Parameters
- callId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
dial
calleeUserId: string,
isVideoCall: boolean,
options: CallOptions,
): Promise<DirectCallProperties>Parameters
- calleeUserId: string
- isVideoCall: boolean
- options: CallOptions
Returns Promise<DirectCallProperties>
direct
Call Delete All Custom Items
Parameters
- callId: string
Returns Promise<CustomItemUpdateResult>
direct
Call Delete Custom Items
callId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
direct
Call Update Custom Items
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
end
Parameters
- callId: string
Returns Promise<void>
enter
Parameters
- roomId: string
- options: EnterParams
Returns Promise<void>
exit
Parameters
- roomId: string
Returns void
fetch
Room By Id
Parameters
- roomId: string
Returns Promise<RoomProperties>
get
Cached Room By Id
Parameters
- roomId: string
Returns Promise<RoomProperties | null>
OptionalgetConstants
Returns {}
get
Current User
Returns Promise<User | null>
get
Direct Call
Parameters
- callId: string
Returns Promise<DirectCallProperties>
get
Ongoing Calls
Returns Promise<DirectCallProperties[]>
group
Call Delete All Custom Items
Parameters
- roomId: string
Returns Promise<CustomItemUpdateResult>
group
Call Delete Custom Items
roomId: string,
customItemKeys: string[],
): Promise<CustomItemUpdateResult>Parameters
- roomId: string
- customItemKeys: string[]
Returns Promise<CustomItemUpdateResult>
group
Call Update Custom Items
roomId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- roomId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
handle
Firebase Message Data
initialize
Parameters
- appId: string
Returns boolean
mute
Microphone
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
query
Next
key: `native#${string}`,
type: T,
): NativeQueryResult<
T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties,
>Type Parameters
- T extends NativeQueryType
Parameters
- key: `native#${string}`
- type: T
Returns NativeQueryResult<T extends DIRECT_CALL_LOG ? DirectCallLog : RoomProperties>
query
Release
Parameters
- key: `native#${string}`
Returns void
register
Push Token
Parameters
- token: string
Optionalunique: booleanReturns Promise<void>
register
Vo IP Push Token
remove
Direct Call Sound
Parameters
- type: SoundType
Returns void
resume
Audio Track
resume
Video Capturer
route
Picker View
select
Audio Device
type: ControllableModuleType,
identifier: string,
device: AudioDeviceType,
): Promise<void>Parameters
- type: ControllableModuleType
- identifier: string
- device: AudioDeviceType
Returns Promise<void>
select
Video Device
type: ControllableModuleType,
identifier: string,
device: VideoDevice,
): Promise<void>Parameters
- type: ControllableModuleType
- identifier: string
- device: VideoDevice
Returns Promise<void>
set
Direct Call Dialing Sound On When Silent Or Vibrate Mode
Parameters
- enabled: boolean
Returns void
set
Logger Level
Parameters
- level: "none" | "error" | "warning" | "info"
Returns void
start
Video
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
stop
Video
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
switch
Camera
Parameters
- type: ControllableModuleType
- identifier: string
Returns Promise<void>
unmute
Microphone
Parameters
- type: ControllableModuleType
- identifier: string
Returns void
unregister
Push Token
Parameters
- token: string
Returns Promise<void>
unregister
Vo IP Push Token
update
Custom Items
callId: string,
customItems: Record<string, string>,
): Promise<CustomItemUpdateResult>Parameters
- callId: string
- customItems: Record<string, string>
Returns Promise<CustomItemUpdateResult>
update
Local Video View
Parameters
- callId: string
- videoViewId: number
Returns void
update
Remote Video View
Parameters
- callId: string
- videoViewId: number
Returns void
User | @sendbird/calls-react-native diff --git a/docs/interfaces/VideoDevice.html b/docs/interfaces/VideoDevice.html index 361cf68..84849e6 100644 --- a/docs/interfaces/VideoDevice.html +++ b/docs/interfaces/VideoDevice.html @@ -1,6 +1,6 @@ -Interface User
interface User {
isActive: boolean;
metaData: Record<string, string>;
nickname: string;
profileUrl: string;
userId: string;
}Hierarchy (View Summary)
- User
Index
Properties
isActive + User | @sendbird/calls-react-native +Interface User
interface User {
isActive: boolean;
metaData: Record<string, string>;
nickname: string;
profileUrl: string;
userId: string;
}Hierarchy (View Summary)
- User
Index
Properties
VideoDevice | @sendbird/calls-react-native diff --git a/docs/types/AudioDevice.html b/docs/types/AudioDevice.html index 381bac4..e41082a 100644 --- a/docs/types/AudioDevice.html +++ b/docs/types/AudioDevice.html @@ -1 +1 @@ -Interface VideoDevice
Index
Properties
deviceId + VideoDevice | @sendbird/calls-react-native + position
AudioDevice | @sendbird/calls-react-native +Type Alias AudioDevice
AudioDevice | @sendbird/calls-react-native diff --git a/docs/types/AudioDeviceChangedInfo.html b/docs/types/AudioDeviceChangedInfo.html index b9d65b1..6968c3b 100644 --- a/docs/types/AudioDeviceChangedInfo.html +++ b/docs/types/AudioDeviceChangedInfo.html @@ -1 +1 @@ -Type Alias AudioDevice
AudioDeviceChangedInfo | @sendbird/calls-react-native +Type Alias AudioDeviceChangedInfo
AudioDeviceChangedInfo:
| {
data: {
availableAudioDevices: AudioDevice[]
| null;
currentAudioDevice: AudioDevice | null;
};
platform: "android";
}
| {
data: {
currentRoute: AudioDeviceRoute;
previousRoute: AudioDeviceRoute;
reason: RouteChangeReason;
};
platform: "ios";
}AudioDeviceChangedInfo | @sendbird/calls-react-native diff --git a/docs/types/AudioDeviceRoute.html b/docs/types/AudioDeviceRoute.html index 8a6659a..5391857 100644 --- a/docs/types/AudioDeviceRoute.html +++ b/docs/types/AudioDeviceRoute.html @@ -1,3 +1,3 @@ -Type Alias AudioDeviceChangedInfo
AudioDeviceChangedInfo:
| {
data: {
availableAudioDevices: AudioDevice[]
| null;
currentAudioDevice: AudioDevice | null;
};
platform: "android";
}
| {
data: {
currentRoute: AudioDeviceRoute;
previousRoute: AudioDeviceRoute;
reason: RouteChangeReason;
};
platform: "ios";
}AudioDeviceRoute | @sendbird/calls-react-native diff --git a/docs/types/CallOptions.html b/docs/types/CallOptions.html index fd19d22..76e26ee 100644 --- a/docs/types/CallOptions.html +++ b/docs/types/CallOptions.html @@ -1,4 +1,4 @@ -Type Alias AudioDeviceRoute
CallOptions | @sendbird/calls-react-native diff --git a/docs/types/CustomItemUpdateResult.html b/docs/types/CustomItemUpdateResult.html index 60e957d..cac4cd5 100644 --- a/docs/types/CustomItemUpdateResult.html +++ b/docs/types/CustomItemUpdateResult.html @@ -1,3 +1,3 @@ -Type Alias CallOptions
type CallOptions = {
audioEnabled?: boolean;
channelUrl?: string;
frontCamera?: boolean;
localVideoViewId?: number;
remoteVideoViewId?: number;
videoEnabled?: boolean;
}
Index
Properties
audioEnabled? + CallOptions | @sendbird/calls-react-native +Type Alias CallOptions
type CallOptions = {
audioEnabled?: boolean;
channelUrl?: string;
frontCamera?: boolean;
localVideoViewId?: number;
remoteVideoViewId?: number;
videoEnabled?: boolean;
}
Index
Properties
Properties
OptionalaudioEnabled audioEnabled?: boolean
OptionalchannelUrl channelUrl?: stringFor SendbirdChat integration *
-
OptionalfrontCamera frontCamera?: boolean
OptionalchannelUrl channelUrl?: stringFor SendbirdChat integration *
+
OptionalfrontCamera frontCamera?: boolean
OptionallocalVideo View Id localVideoViewId?: number
OptionalremoteVideo View Id remoteVideoViewId?: number
OptionalvideoEnabled videoEnabled?: boolean
OptionallocalVideo View Id localVideoViewId?: number
OptionalremoteVideo View Id remoteVideoViewId?: number
OptionalvideoEnabled videoEnabled?: booleanCustomItemUpdateResult | @sendbird/calls-react-native diff --git a/docs/types/DirectCallLogQueryParams.html b/docs/types/DirectCallLogQueryParams.html index a8444a4..81fca74 100644 --- a/docs/types/DirectCallLogQueryParams.html +++ b/docs/types/DirectCallLogQueryParams.html @@ -1,4 +1,4 @@ -Type Alias CustomItemUpdateResult
Index
Properties
affectedKeys + CustomItemUpdateResult | @sendbird/calls-react-native +Type Alias CustomItemUpdateResult
Index
Properties
DirectCallLogQueryParams | @sendbird/calls-react-native diff --git a/docs/types/EnterParams.html b/docs/types/EnterParams.html index 8a3e10e..2362a06 100644 --- a/docs/types/EnterParams.html +++ b/docs/types/EnterParams.html @@ -1,9 +1,9 @@ -Type Alias DirectCallLogQueryParams
type DirectCallLogQueryParams = {
endResults?: DirectCallEndResult[];
limit?: number;
myRole?: DirectCallUserRole | "ALL";
}
Index
Properties
endResults? + DirectCallLogQueryParams | @sendbird/calls-react-native +Type Alias DirectCallLogQueryParams
type DirectCallLogQueryParams = {
endResults?: DirectCallEndResult[];
limit?: number;
myRole?: DirectCallUserRole | "ALL";
}
Index
Properties
EnterParams | @sendbird/calls-react-native diff --git a/docs/types/JSMediaDeviceControl.html b/docs/types/JSMediaDeviceControl.html index 3bac0f8..337ed86 100644 --- a/docs/types/JSMediaDeviceControl.html +++ b/docs/types/JSMediaDeviceControl.html @@ -1 +1 @@ -Type Alias EnterParams
Index
Properties
JSMediaDeviceControl | @sendbird/calls-react-native +Type Alias JSMediaDeviceControl
JSMediaDeviceControl | @sendbird/calls-react-native diff --git a/docs/types/LocalParticipantMethods.html b/docs/types/LocalParticipantMethods.html index d16faca..6d2f9d1 100644 --- a/docs/types/LocalParticipantMethods.html +++ b/docs/types/LocalParticipantMethods.html @@ -1 +1 @@ -Type Alias JSMediaDeviceControl
LocalParticipantMethods | @sendbird/calls-react-native +Type Alias LocalParticipantMethods
LocalParticipantMethods: AsJSInterface<
JSLocalParticipantMediaDeviceControl,
"android",
"resumeVideoCapturer"
| "resumeAudioTrack",
>LocalParticipantMethods | @sendbird/calls-react-native diff --git a/docs/types/NativeConstants.html b/docs/types/NativeConstants.html index 2146c1d..6640fcf 100644 --- a/docs/types/NativeConstants.html +++ b/docs/types/NativeConstants.html @@ -1,2 +1,2 @@ -Type Alias LocalParticipantMethods
LocalParticipantMethods: AsJSInterface<
JSLocalParticipantMediaDeviceControl,
"android",
"resumeVideoCapturer"
| "resumeAudioTrack",
>NativeConstants | @sendbird/calls-react-native +Type Alias NativeConstants
Index
Properties
NativeConstants | @sendbird/calls-react-native diff --git a/docs/types/NativeQueryCreator.html b/docs/types/NativeQueryCreator.html index 95f3caf..d7d8863 100644 --- a/docs/types/NativeQueryCreator.html +++ b/docs/types/NativeQueryCreator.html @@ -1 +1 @@ -Type Alias NativeConstants
Index
Properties
NativeQueryCreator | @sendbird/calls-react-native +Type Alias NativeQueryCreator<QueryParams>
Type Parameters
- QueryParams
Type Declaration
- (params: QueryParams): Promise<`native#${string}`>
Parameters
- params: QueryParams
Returns Promise<`native#${string}`>
NativeQueryCreator | @sendbird/calls-react-native diff --git a/docs/types/NativeQueryKey.html b/docs/types/NativeQueryKey.html index 6761c4e..45ef7eb 100644 --- a/docs/types/NativeQueryKey.html +++ b/docs/types/NativeQueryKey.html @@ -1 +1 @@ -Type Alias NativeQueryCreator<QueryParams>
Type Parameters
- QueryParams
Type Declaration
- (params: QueryParams): Promise<`native#${string}`>
Parameters
- params: QueryParams
Returns Promise<`native#${string}`>
NativeQueryKey | @sendbird/calls-react-native +Type Alias NativeQueryKey
NativeQueryKey: `native#${string}`NativeQueryKey | @sendbird/calls-react-native diff --git a/docs/types/NativeQueryResult.html b/docs/types/NativeQueryResult.html index 777a3ad..3aebaca 100644 --- a/docs/types/NativeQueryResult.html +++ b/docs/types/NativeQueryResult.html @@ -1 +1 @@ -Type Alias NativeQueryKey
NativeQueryKey: `native#${string}`NativeQueryResult | @sendbird/calls-react-native +Type Alias NativeQueryResult<T>
Type Parameters
- T
NativeQueryResult | @sendbird/calls-react-native diff --git a/docs/types/Port.html b/docs/types/Port.html index 0d66204..bc65db7 100644 --- a/docs/types/Port.html +++ b/docs/types/Port.html @@ -1,3 +1,3 @@ -Type Alias NativeQueryResult<T>
Type Parameters
- T
Port | @sendbird/calls-react-native diff --git a/docs/types/Range.html b/docs/types/Range.html index 302921c..423c5bf 100644 --- a/docs/types/Range.html +++ b/docs/types/Range.html @@ -1,3 +1,3 @@ -Type Alias Port
Index
Properties
Range | @sendbird/calls-react-native diff --git a/docs/types/RecordingOptions.html b/docs/types/RecordingOptions.html index b6a76c2..5816bc7 100644 --- a/docs/types/RecordingOptions.html +++ b/docs/types/RecordingOptions.html @@ -1,6 +1,6 @@ -Type Alias Range
Index
Properties
RecordingOptions | @sendbird/calls-react-native diff --git a/docs/types/RoomListQueryParams.html b/docs/types/RoomListQueryParams.html index 5fd445a..68200a0 100644 --- a/docs/types/RoomListQueryParams.html +++ b/docs/types/RoomListQueryParams.html @@ -1,8 +1,8 @@ -Type Alias RecordingOptions
Index
Properties
directoryPath + RecordingOptions | @sendbird/calls-react-native +Type Alias RecordingOptions
Index
Properties
OptionalfileName fileName?: stringUsed to specify a name of the recorded file. If unspecified, it will be saved as
+{type}_{callId}_{timestamp}. *recording
Type RoomListQueryParams | @sendbird/calls-react-native diff --git a/docs/types/RoomParams.html b/docs/types/RoomParams.html index a6e96e1..a4902bc 100644 --- a/docs/types/RoomParams.html +++ b/docs/types/RoomParams.html @@ -1,2 +1,2 @@ -Type Alias RoomListQueryParams
type RoomListQueryParams = {
createdAt?: Range;
createdByUserIds?: string[];
currentParticipantCount?: Range;
limit?: number;
roomIds?: string[];
state?: RoomState;
type?: RoomType;
}
Index
Properties
createdAt? + RoomListQueryParams | @sendbird/calls-react-native + RoomParams | @sendbird/calls-react-native +RoomParams | @sendbird/calls-react-native diff --git a/docs/variables/Logger.html b/docs/variables/Logger.html index cf1fddd..ca74edd 100644 --- a/docs/variables/Logger.html +++ b/docs/variables/Logger.html @@ -1 +1 @@ -Logger | @sendbird/calls-react-native +Variable Logger
ConstLogger: {
error(...args: unknown[]): number;
getLogLevel(): "none" | "error" | "warning" | "info";
info(...args: unknown[]): number;
setLogLevel(lv: "none" | "error" | "warning" | "info"): void;
setTitle(title: string): void;
warn(...args: unknown[]): number;
} = ...Type Declaration
error: function
Parameters
- ...args: unknown[]
Returns number
getLogLevel: function
Returns "none" | "error" | "warning" | "info"
info: function
Parameters
- ...args: unknown[]
Returns number
setLogLevel: function
Parameters
- lv: "none" | "error" | "warning" | "info"
Returns void
setTitle: function
Parameters
- title: string
Returns void
warn: function
Parameters
- ...args: unknown[]
Returns number
Logger | @sendbird/calls-react-native diff --git a/docs/variables/SendbirdCalls.html b/docs/variables/SendbirdCalls.html index 85ed0e0..713ef78 100644 --- a/docs/variables/SendbirdCalls.html +++ b/docs/variables/SendbirdCalls.html @@ -1 +1 @@ -Variable Logger
ConstLogger: {
error(...args: unknown[]): number;
getLogLevel(): "none" | "error" | "warning" | "info";
info(...args: unknown[]): number;
setLogLevel(lv: "none" | "error" | "warning" | "info"): void;
setTitle(title: string): void;
warn(...args: unknown[]): number;
} = ...Type Declaration
error: function
Parameters
- ...args: unknown[]
Returns number
getLogLevel: function
Returns "none" | "error" | "warning" | "info"
info: function
Parameters
- ...args: unknown[]
Returns number
setLogLevel: function
Parameters
- lv: "none" | "error" | "warning" | "info"
Returns void
setTitle: function
Parameters
- title: string
Returns void
warn: function
Parameters
- ...args: unknown[]
Returns number
SendbirdCalls | @sendbird/calls-react-native +Variable SendbirdCalls
ConstSendbirdCalls | @sendbird/calls-react-native diff --git a/package.json b/package.json index 5513af4..d1afe8a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@sendbird/calls-react-native", - "version": "1.1.9", + "version": "1.1.10", "description": "Sendbird Calls SDK for React Native: Empower React Native apps with seamless audio, video, and group calling. Build interactive communication easily.", "main": "lib/commonjs/index", "module": "lib/module/index",Variable SendbirdCalls
Const
Gets available audio devices.
+