Skip to main content

Providers & Contexts

Also exported from this package

Everything in @video/video-client-core is re-exported by @video/video-client-react. You can import core types and clients directly from @video/video-client-react — they are documented on the core reference page, not below.

EchoPillarboxContext​

React context carrying the EchoPillarboxStyles object used by the pillarbox component. Consumers may read it directly or pull it via the pillarbox component's own props.

const EchoPillarboxContext: React.Context<EchoPillarboxStyles | literal>

PeerAPIContext​

React context carrying a types.PeerAPI instance. Exposed so consumers can inspect or override the value directly; most callers should use PeerAPIProvider and usePeerAPI instead.

const PeerAPIContext: React.Context<any>

ActivePlaceholderAPIProvider​

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

import { ActivePlaceholderAPIProvider } from '@video/video-client-react';
function ActivePlaceholderAPIProvider(props: object): React.ReactElement

Props​

object
activePlaceholderAPIActivePlaceholderAPI
canvasIntervalunknown
element (required)unknown
isDisposed (required)boolean
childrenReact.ReactNode

AuthClientAPIProvider​

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

Used in

import { AuthClientAPIProvider } from '@video/video-client-react';
function AuthClientAPIProvider(props: object): React.ReactElement

Props​

object
authClientAuthClient
abilities (required)Set
childrenReact.ReactNode

BroadcastAPIProvider​

Re-exports the broadcast context provider and consumer hook.

Used in

import { BroadcastAPIProvider } from '@video/video-client-react';
function BroadcastAPIProvider(props: object): React.ReactElement

Props​

object
broadcastAPIBroadcastAPI
__events (required)BroadcastEvents
audioMuted (required)boolean
error (required)unknown
isDisposed (required)boolean
state (required)unknown
streamName (required)string
videoHidden (required)boolean
childrenReact.ReactNode

CallAPIProvider​

Re-exports the call context provider and consumer hook.

Used in

import { CallAPIProvider } from '@video/video-client-react';
function CallAPIProvider(props: object): React.ReactElement

Props​

object
callAPICallAPI
__events (required)CallEvents
broadcasts (required)Map
id (required)string
isDisposed (required)boolean
isOwner (required)boolean
peers (required)unknown
state (required)unknown
videoCodecGap (required)unknown
childrenReact.ReactNode

CameraControllerProvider​

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

import { CameraControllerProvider } from '@video/video-client-react';
function CameraControllerProvider(props: object): React.ReactElement

Props​

object
cameraCameraController
childrenReact.ReactNode

CanvasControllerProvider​

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

import { CanvasControllerProvider } from '@video/video-client-react';
function CanvasControllerProvider(props: object): React.ReactElement

Props​

object
canvasCanvasController
childrenReact.ReactNode

CompositionStreamControllerProvider​

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

import { CompositionStreamControllerProvider } from '@video/video-client-react';
function CompositionStreamControllerProvider(props: CompositionStreamControllerProviderProps): React.ReactElement

Attributes

  • propsCompositionStreamControllerProviderPropsRequired

EchoPillarboxProvider​

Re-exports the echo-pillarbox context and provider used by the pillarbox component to share its style overrides with child video elements.

import { EchoPillarboxProvider } from '@video/video-client-react';
function EchoPillarboxProvider(props: object): React.ReactElement

Props​

object
childrenReact.ReactNode

MediaContextProvider​

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

import { MediaContextProvider } from '@video/video-client-react';
function MediaContextProvider(props: object): React.ReactElement

Props​

object
childrenReact.ReactNode
contextMediaContextWithState

MediaStreamControllerAPIProvider​

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

Used in

import { MediaStreamControllerAPIProvider } from '@video/video-client-react';
function MediaStreamControllerAPIProvider(props: object): React.ReactElement

Props​

object
childrenReact.ReactNode
mediaStreamControllerAPIMediaStreamControllerAPI
__events (required)MediaStreamControllerEvents
aspectRatio (required)unknown
audioDeviceId (required)unknown
audioDeviceRemoved (required)unknown
audioDisabled (required)unknown
audioMuted (required)boolean
autoGainControl (required)unknown
availableResolutions (required)unknown
capturable (required)unknown
echoCancellation (required)unknown
facingMode (required)unknown
frameRate (required)unknown
gain (required)number
inAudioDeviceTransition (required)boolean
inVideoDeviceTransition (required)boolean
isScreenCaptured (required)boolean
kind (required)unknown
logger (required)Logger
maxHeight (required)unknown
maxWidth (required)unknown
noiseSuppression (required)unknown
resolution (required)unknown
settings (required)unknown
videoDeviceId (required)unknown
videoDeviceRemoved (required)unknown
videoDisabled (required)unknown
videoPaused (required)boolean

MicrophoneControllerProvider​

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

import { MicrophoneControllerProvider } from '@video/video-client-react';
function MicrophoneControllerProvider(props: object): React.ReactElement

Props​

object
childrenReact.ReactNode
microphoneMicrophoneController

PeerAPIProvider​

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

Used in

import { PeerAPIProvider } from '@video/video-client-react';
function PeerAPIProvider(props: object): React.ReactElement

Props​

object
childrenReact.ReactNode
peerAPIPeerAPI
__events (required)PeerEvents
appData (required)Record
callCallAPI
displayNamestring
isDisposed (required)boolean
peerIdstring
streams (required)unknown
userIdstring

PlayerAPIProvider​

Re-exports the player context provider and consumer hook.

Used in

import { PlayerAPIProvider } from '@video/video-client-react';
function PlayerAPIProvider(props: object): React.ReactElement

Props​

object
childrenReact.ReactNode
playerAPIPlayerAPI
__events (required)PlayerAPIEvents
fullScreenHandlersunknown

ResolutionsInUseManagerAPIProvider​

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

import { ResolutionsInUseManagerAPIProvider } from '@video/video-client-react';
function ResolutionsInUseManagerAPIProvider(props: object): React.ReactElement

Props​

object
childrenReact.ReactNode
resolutionsInUseManagerAPIResolutionsInUseManagerAPI
__events (required)ResolutionsInUseManagerEvents
currentAvailableResolutions (required)unknown
devicesInUse (required)Map
isDisposed (required)boolean

ScreenVideoControllerProvider​

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

import { ScreenVideoControllerProvider } from '@video/video-client-react';
function ScreenVideoControllerProvider(props: object): React.ReactElement

Props​

object
childrenReact.ReactNode
screenVideoScreenVideoController