Options
All
  • Public
  • Public/Protected
  • All
Menu

@sendbird/calls-react-native

Index

Type Aliases

AudioDevice: AudioDeviceType
AudioDeviceChangedInfo: { data: { availableAudioDevices: AudioDevice[] | null; currentAudioDevice: AudioDevice | null }; platform: "android" } | { data: { currentRoute: AudioDeviceRoute; previousRoute: AudioDeviceRoute; reason: RouteChangeReason }; platform: "ios" }
AudioDeviceRoute: { inputs: Port[]; outputs: Port[] }

Type declaration

CallOptions: { audioEnabled?: boolean; channelUrl?: string; frontCamera?: boolean; localVideoViewId?: number; remoteVideoViewId?: number; videoEnabled?: boolean }

Type declaration

  • Optional audioEnabled?: boolean
    default

    true

  • Optional channelUrl?: string

    For SendbirdChat integration

  • Optional frontCamera?: boolean
    default

    true

  • Optional localVideoViewId?: number
  • Optional remoteVideoViewId?: number
  • Optional videoEnabled?: boolean
    default

    true

CustomItemUpdateResult: { affectedKeys: string[]; updatedItems: Record<string, string> }

Type declaration

  • affectedKeys: string[]
  • updatedItems: Record<string, string>
DirectCallLogQueryParams: { endResults?: DirectCallEndResult[]; limit?: number; myRole?: DirectCallUserRole | "ALL" }

Type declaration

EnterParams: { audioEnabled?: boolean; videoEnabled?: boolean }

Type declaration

  • Optional audioEnabled?: boolean
    default

    true

  • Optional videoEnabled?: boolean
    default

    true

JSMediaDeviceControl: AsJSMediaDeviceControl<NativeMediaDeviceControl>
LocalParticipantMethods: JSLocalParticipantMediaDeviceControl
NativeConstants: { NATIVE_SDK_VERSION: string }

Type declaration

  • NATIVE_SDK_VERSION: string
NativeQueryCreator<QueryParams>: ((params: QueryParams) => Promise<`native#${string}`>)

Type Parameters

  • QueryParams

Type declaration

    • (params: QueryParams): Promise<`native#${string}`>
    • Parameters

      • params: QueryParams

      Returns Promise<`native#${string}`>

NativeQueryKey: `native#${string}`
NativeQueryResult<T>: Promise<{ hasNext: boolean; result: T[] }>

Type Parameters

  • T

Port: { name: string; type: AVAudioSessionPort }

Type declaration

RecordingOptions: { directoryPath: string; fileName?: string; recordingType: RecordingType }

Type declaration

  • directoryPath: string

    Used to specify the base directory path of where the recorded file will be saved

  • Optional fileName?: string

    Used to specify a name of the recorded file. If unspecified, it will be saved as {type}_{callId}_{timestamp}.

  • recordingType: RecordingType
RoomListQueryParams: { createdAt?: Range; createdByUserIds?: string[]; currentParticipantCount?: Range; limit?: number; roomIds?: string[]; state?: RoomState; type?: RoomType }

Type declaration

  • Optional createdAt?: Range
  • Optional createdByUserIds?: string[]
  • Optional currentParticipantCount?: Range
  • Optional limit?: number
  • Optional roomIds?: string[]
  • Optional state?: RoomState
  • Optional type?: RoomType
RoomParams: { roomType: RoomType }

Type declaration

Variables

Logger: { error: any; getLogLevel: any; info: any; setLogLevel: any; setTitle: any; warn: any } = ...

Type declaration

  • error:function
    • error(...args: unknown[]): number
  • getLogLevel:function
    • getLogLevel(): "none" | "error" | "warning" | "info"
  • info:function
    • info(...args: unknown[]): number
  • setLogLevel:function
    • setLogLevel(lv: "none" | "error" | "warning" | "info"): void
  • setTitle:function
    • setTitle(title: string): void
  • warn:function
    • warn(...args: unknown[]): number
SendbirdCalls: SendbirdCallsModule = ...

Generated using TypeDoc