Hooks

useActivePlaceholderAPI

Re-exports the active-placeholder context provider and consumer hook.

import { useActivePlaceholderAPI } from '@video/video-client-react';

function useActivePlaceholderAPI(): ActivePlaceholderAPI

No parameters

useAudioDevices

Re-exports the media-controller hooks. Covers device enumeration (useAudioDevices, useVideoDevices), per-device controllers (useCameraController, useMicrophoneController, useCanvasController, useScreenVideoController), the combined useCompositionStreamController, the shared useMediaContext, and usePermission for camera/microphone permission state.

import { useAudioDevices } from '@video/video-client-react';

function useAudioDevices(ctx: MediaContextWithState): MediaDeviceInfo[]

Attributes

• ctxMediaContextWithStateRequired

useAuthClient

Re-exports the useAuthClient hook.

import { useAuthClient } from '@video/video-client-react';

function useAuthClient(token: string | literal, refresh?: object): AuthClient

Attributes

• tokenstring | undefinedRequired

• refreshobjectOptional

useAuthClientAPI

Re-exports the auth-client context provider and consumer hook.

import { useAuthClientAPI } from '@video/video-client-react';

function useAuthClientAPI(): AuthClient

No parameters

useBroadcast

Re-exports the useBroadcast hook.

import { useBroadcast } from '@video/video-client-react';

function useBroadcast(call: any, controller: any, broadcastOptions: BroadcastOptions, options?: UseCallLifecycleOptions): UseBroadcastReturn

Attributes

• callanyRequired

• controlleranyRequired

• broadcastOptionsBroadcastOptionsRequired

• optionsUseCallLifecycleOptionsOptional

useBroadcastAPI

Re-exports the broadcast context provider and consumer hook.

import { useBroadcastAPI } from '@video/video-client-react';

function useBroadcastAPI(): BroadcastAPI

No parameters

useCallAPI

Re-exports the call context provider and consumer hook.

import { useCallAPI } from '@video/video-client-react';

function useCallAPI(): CallAPI

No parameters

useCallPeers

Re-exports the useCallPeers hook.

import { useCallPeers } from '@video/video-client-react';

function useCallPeers(call: CallAPI): CallEvents[]

Props

CallAPI

__events (required)CallEvents

accessDenied (required)unknown

callClosed (required)unknown

callEnded (required)void

callId (required)unknown

callJoinEndpoint (required)void

callReady (required)boolean

disposed (required)void

dominantSpeaker (required)DominantSpeaker

error (required)Error

isConnected (required)boolean

isConnecting (required)boolean

peerAdded (required)unknown

peerAtCapacity (required)boolean

peerRemoved (required)unknown

playerAdded (required)unknown

playerRemoved (required)unknown

producerStats (required)unknown

sfuConnection (required)void

streamAdded (required)unknown

streamRemoved (required)unknown

transportStateChange (required)unknown

videoCodecGap (required)VideoCodecGapInfo

videoConsumer (required)void

viewerKicked (required)void

websocketReconnect (required)void

zeroBitrate (required)unknown

broadcasts (required)Map

id (required)string

isDisposed (required)boolean

isOwner (required)boolean

peers (required)PeerAPI[]

state (required)unknown | unknown | unknown | unknown

videoCodecGap (required)VideoCodecGapInfo | unknown

useCameraController

Re-exports the media-controller hooks. Covers device enumeration (useAudioDevices, useVideoDevices), per-device controllers (useCameraController, useMicrophoneController, useCanvasController, useScreenVideoController), the combined useCompositionStreamController, the shared useMediaContext, and usePermission for camera/microphone permission state.

import { useCameraController } from '@video/video-client-react';

function useCameraController(ctx: MediaContext, options?: any): CameraController

Attributes

• ctxMediaContextRequired

• optionsanyOptional

useCameraControllerContext

Re-exports the camera-controller context provider and consumer hook.

import { useCameraControllerContext } from '@video/video-client-react';

function useCameraControllerContext(): CameraController

No parameters

useCanvasController

Re-exports the media-controller hooks. Covers device enumeration (useAudioDevices, useVideoDevices), per-device controllers (useCameraController, useMicrophoneController, useCanvasController, useScreenVideoController), the combined useCompositionStreamController, the shared useMediaContext, and usePermission for camera/microphone permission state.

import { useCanvasController } from '@video/video-client-react';

function useCanvasController(ctx: MediaContext, options?: any): CanvasController

Attributes

• ctxMediaContextRequired

• optionsanyOptional

useCanvasControllerContext

Re-exports the canvas-controller context provider and consumer hook.

import { useCanvasControllerContext } from '@video/video-client-react';

function useCanvasControllerContext(): CanvasController

No parameters

useCompositionStreamController

Re-exports the media-controller hooks. Covers device enumeration (useAudioDevices, useVideoDevices), per-device controllers (useCameraController, useMicrophoneController, useCanvasController, useScreenVideoController), the combined useCompositionStreamController, the shared useMediaContext, and usePermission for camera/microphone permission state.

import { useCompositionStreamController } from '@video/video-client-react';

function useCompositionStreamController(ctx: MediaContext, options: UseCompositionStreamControllerOptions): CompositionStreamController

Attributes

• ctxMediaContextRequired

• optionsUseCompositionStreamControllerOptionsRequired

useCompositionStreamControllerContext

Re-exports the composition-stream-controller context provider and consumer hook (accepts any CompositionStreamControllerAPI source).

import { useCompositionStreamControllerContext } from '@video/video-client-react';

function useCompositionStreamControllerContext(): CompositionStreamControllerAPI

No parameters

useCreateCall

Re-exports the useCreateCall hook.

import { useCreateCall } from '@video/video-client-react';

function useCreateCall(callOptions: any, options?: UseCallLifecycleOptions): UseCallReturn

Attributes

• callOptionsanyRequired

• optionsUseCallLifecycleOptionsOptional

useEvent

Re-exports the useEvent hook.

import { useEvent } from '@video/video-client-react';

function useEvent(emitter: EventEmitter<Events>, ...events: Name[]): void

Attributes

• emitterEventEmitterRequired

• eventsName[]Required

useGetResolution

Returns a memoised getter that reads a single numeric height from a media-stream controller's resolution field, regardless of whether the controller has it stored as a number, a tuple, or a constraint range.

import { useGetResolution } from '@video/video-client-react';

function useGetResolution(resolution: MediaStreamControllerAPI): object

Props

MediaStreamControllerAPI

__events (required)MediaStreamControllerEvents

disposed (required)void

source (required)MediaStream

tracksChanged (required)MediaStream

aspectRatio (required)unknown

audioConstraintsError (required)unknown

audioDeviceChanged (required)unknown

audioDeviceChanging (required)unknown

audioDeviceRemoved (required)unknown

audioDisabled (required)unknown

audioMuted (required)unknown

autoGainControl (required)unknown

availableResolutions (required)unknown

captureStreamStarted (required)void

changeDevicesError (required)unknown

echoCancellation (required)unknown

error (required)Error

facingMode (required)unknown

frameRate (required)unknown

gain (required)unknown

maxHeight (required)unknown

maxWidth (required)unknown

noiseSuppression (required)unknown

resolution (required)unknown

videoConstraintsError (required)unknown

videoDeviceChanged (required)unknown

videoDeviceChanging (required)unknown

videoDeviceRemoved (required)unknown

videoDisabled (required)unknown

videoPaused (required)unknown

aspectRatio (required)number | unknown | unknown

audioDeviceId (required)string | unknown

audioDeviceRemoved (required)string | unknown

audioDisabled (required)boolean | unknown

audioMuted (required)boolean

autoGainControl (required)boolean | unknown

availableResolutions (required)number[]

capturable (required)Capturable | unknown

echoCancellation (required)boolean | unknown

facingMode (required)FacingMode | unknown

frameRate (required)ConstrainDouble | unknown

gain (required)number

inAudioDeviceTransition (required)boolean

inVideoDeviceTransition (required)boolean

isScreenCaptured (required)boolean

kind (required)unknown

logger (required)Logger

maxHeight (required)number | unknown

maxWidth (required)number | unknown

noiseSuppression (required)boolean | unknown

resolution (required)number | unknown | unknown | unknown

settings (required)object

audioMediaTrackSettings

audioCtxunknown

videoMediaTrackSettings

videoDeviceId (required)string | unknown

videoDeviceRemoved (required)string | unknown

videoDisabled (required)boolean | unknown

videoPaused (required)boolean

useJoinCall

Re-exports the useJoinCall hook.

import { useJoinCall } from '@video/video-client-react';

function useJoinCall(callId: string | literal, joinCallOptions: any, options?: UseCallLifecycleOptions): UseCallReturn

Attributes

• callIdstring | undefinedRequired

• joinCallOptionsanyRequired

• optionsUseCallLifecycleOptionsOptional

useMediaContext

Re-exports the media-controller hooks. Covers device enumeration (useAudioDevices, useVideoDevices), per-device controllers (useCameraController, useMicrophoneController, useCanvasController, useScreenVideoController), the combined useCompositionStreamController, the shared useMediaContext, and usePermission for camera/microphone permission state.

import { useMediaContext } from '@video/video-client-react';

function useMediaContext(options?: any): MediaContextWithState

Attributes

• optionsanyOptional

useMediaContextRequired

Re-exports the media-context provider and its required-consumer hook (useMediaContextRequired throws when no provider is present).

import { useMediaContextRequired } from '@video/video-client-react';

function useMediaContextRequired(): MediaContextWithState

No parameters

useMediaStreamControllerAPI

Re-exports the media-stream-controller context provider and consumer hook.

import { useMediaStreamControllerAPI } from '@video/video-client-react';

function useMediaStreamControllerAPI(): MediaStreamControllerAPI

No parameters

useMicrophoneController

Re-exports the media-controller hooks. Covers device enumeration (useAudioDevices, useVideoDevices), per-device controllers (useCameraController, useMicrophoneController, useCanvasController, useScreenVideoController), the combined useCompositionStreamController, the shared useMediaContext, and usePermission for camera/microphone permission state.

import { useMicrophoneController } from '@video/video-client-react';

function useMicrophoneController(ctx: MediaContext, options?: any): MicrophoneController

Attributes

• ctxMediaContextRequired

• optionsanyOptional

useMicrophoneControllerContext

Re-exports the microphone-controller context provider and consumer hook.

import { useMicrophoneControllerContext } from '@video/video-client-react';

function useMicrophoneControllerContext(): MicrophoneController

No parameters

usePeerAPI

Re-exports the peer context, provider, and consumer hook.

import { usePeerAPI } from '@video/video-client-react';

function usePeerAPI(): PeerAPI

No parameters

usePermission

Re-exports the media-controller hooks. Covers device enumeration (useAudioDevices, useVideoDevices), per-device controllers (useCameraController, useMicrophoneController, useCanvasController, useScreenVideoController), the combined useCompositionStreamController, the shared useMediaContext, and usePermission for camera/microphone permission state.

import { usePermission } from '@video/video-client-react';

function usePermission(ctx: MediaContextWithState, type: PermissionType): MediaPermissionVariant

Attributes

• ctxMediaContextWithStateRequired

• typePermissionTypeRequired

usePlayerAPI

Re-exports the player context provider and consumer hook.

import { usePlayerAPI } from '@video/video-client-react';

function usePlayerAPI(): PlayerAPI

No parameters

usePreviewPlayer

Re-exports the usePreviewPlayer hook.

import { usePreviewPlayer } from '@video/video-client-react';

function usePreviewPlayer(options: UsePreviewPlayerOptions): UsePreviewPlayerReturn

Props

UsePreviewPlayerOptions

mcOptionsMediaControllerOptions

mscOptionsMediaStreamControllerOptions

capturableCapturable

defaultConstraints (required)unknown

defaultLockPolicy (required)ExistsStreamPolicy

displayNamestring

fallbackConstraints (required)unknown

noEchoGainAmplifierboolean

replaceTracks (required)boolean

requestAudioPermissionboolean

waitingDelay (required)number

previewPlayerOptionsRequestPlayerOptions

useRequestPlayer

Re-exports the useRequestPlayer hook.

import { useRequestPlayer } from '@video/video-client-react';

function useRequestPlayer(options: UseRequestPlayerOptions): any

Props

UseRequestPlayerOptions

eventsMapPartial

requestPlayerOptionsRequestPlayerOptions

source (required)string | MediaStream | SourceProvider

useResolutionsInUseManagerAPI

Re-exports the resolutions-in-use manager context provider and consumer hook.

import { useResolutionsInUseManagerAPI } from '@video/video-client-react';

function useResolutionsInUseManagerAPI(): ResolutionsInUseManagerAPI

No parameters

useScreensharePlayer

Re-exports the useScreensharePlayer hook.

import { useScreensharePlayer } from '@video/video-client-react';

function useScreensharePlayer(args?: UseScreensharePlayerOptions): UseScreensharePlayerReturn

Props

UseScreensharePlayerOptions

screensharePlayerOptionsRequestPlayerOptions

useScreenVideoController

Re-exports the media-controller hooks. Covers device enumeration (useAudioDevices, useVideoDevices), per-device controllers (useCameraController, useMicrophoneController, useCanvasController, useScreenVideoController), the combined useCompositionStreamController, the shared useMediaContext, and usePermission for camera/microphone permission state.

import { useScreenVideoController } from '@video/video-client-react';

function useScreenVideoController(ctx: MediaContext): ScreenVideoController

Props

MediaContext

loggerLogger

useScreenVideoControllerContext

Re-exports the screen-video-controller context provider and consumer hook.

import { useScreenVideoControllerContext } from '@video/video-client-react';

function useScreenVideoControllerContext(): ScreenVideoController

No parameters

useVideoDevices

Re-exports the media-controller hooks. Covers device enumeration (useAudioDevices, useVideoDevices), per-device controllers (useCameraController, useMicrophoneController, useCanvasController, useScreenVideoController), the combined useCompositionStreamController, the shared useMediaContext, and usePermission for camera/microphone permission state.

import { useVideoDevices } from '@video/video-client-react';

function useVideoDevices(ctx: MediaContextWithState): MediaDeviceInfo[]

Attributes

• ctxMediaContextWithStateRequired

useViewerAnalytics

Re-exports the useViewerAnalytics hook.

import { useViewerAnalytics } from '@video/video-client-react';

function useViewerAnalytics(player: any, options: ViewerAnalyticsOptions): void

Attributes

• playeranyRequired

• optionsViewerAnalyticsOptionsRequired