@sendbird/calls-react-native
    Preparing search index...

    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_availableAudioDevices android_currentAudioDevice availableVideoDevices callee caller callId callLog currentVideoDevice customItems duration endedBy endResult ios_callUUID isEnded isLocalAudioEnabled isLocalScreenShareEnabled isLocalVideoEnabled isOngoing isOnHold isRemoteAudioEnabled isRemoteVideoEnabled isVideoCall localRecordingStatus localUser myRole remoteRecordingStatus remoteUser startedAt

    Properties

    android_availableAudioDevices: AudioDeviceType[]

    Gets available audio devices.

    Android

    1.0.0

    android_currentAudioDevice: AudioDeviceType | null

    Gets current audio device.

    Android

    1.0.0

    availableVideoDevices: VideoDevice[]

    Gets available video devices. List of available VideoDevice.

    1.0.0

    callee: DirectCallUser | null

    Gets callee.

    1.0.0

    caller: DirectCallUser | null

    Gets caller.

    1.0.0

    callId: string

    Gets call ID.

    1.0.0

    callLog: DirectCallLog | null

    Gets call log.

    1.0.0

    currentVideoDevice: VideoDevice | null

    Gets current video device.

    1.0.0

    customItems: Record<string, string>

    Gets custom items of this DirectCall instance.

    1.0.0

    duration: number

    Gets call duration(ms).

    1.0.0

    endedBy: DirectCallUser | null

    Gets ender.

    1.0.0

    endResult: DirectCallEndResult

    Gets end result.

    1.0.0

    ios_callUUID: string | null

    The UUID form of callId. Useful when dealing with CallKit.

    iOS

    1.0.0

    isEnded: boolean

    Is ended. True if call is ended. Otherwise, false.

    1.0.0

    isLocalAudioEnabled: boolean

    Is local audio enabled. True if local audio is enabled. Otherwise, false.

    1.0.0

    isLocalScreenShareEnabled: boolean

    Indicates whether the local user's screen is being shared. True if the local user's screen is being shared. Otherwise, false.

    1.0.0

    isLocalVideoEnabled: boolean

    Is local video enabled. True if local video is enabled. Otherwise, false.

    1.0.0

    isOngoing: boolean

    Is ongoing. True if call is ongoing. Otherwise, false.

    1.0.0

    isOnHold: boolean

    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.

    1.0.0

    isRemoteAudioEnabled: boolean

    Is remote audio enabled. True if remote audio is enabled. Otherwise, false.

    1.0.0

    isRemoteVideoEnabled: boolean

    Is remote video enabled. True if remote video is enabled. Otherwise, false.

    1.0.0

    isVideoCall: boolean

    Is video call.

    True if video call. Otherwise, false.

    1.0.0

    localRecordingStatus: RecordingStatus

    Gets local recording status.

    1.0.0

    localUser: DirectCallUser | null

    Gets local user.

    1.0.0

    myRole: DirectCallUserRole | null

    Gets my role.

    1.0.0

    remoteRecordingStatus: RecordingStatus

    Gets remote recording status.

    1.0.0

    remoteUser: DirectCallUser | null

    Gets remote user.

    1.0.0

    startedAt: number

    Gets call startedAt timestamp.

    1.0.0

    Settings

    Member Visibility

    On This Page

    Properties