useLocalMedia

Import

import { useLocalMedia, MediaLoader } from '@relayrtc/react'

Requirements

Call this hook inside RelayProvider, in a React function component or custom hook. A joined room is needed for live data and actions.

Returns

Example

const { camera } = useLocalMedia()
 
return (
  <div>
    {camera?.pending && <MediaLoader label="Starting camera" />}
    <p>{camera?.enabled ? 'Camera enabled' : 'Camera off'}</p>
  </div>
)

Options and behavior

Input snapshots include source, enabled, pending, muted, deviceId, track and publication. Screen snapshots include active, pending, muted, videoTrack, audioTrack, videoPublication and audioPublication. Pending reports a capture, device change or cleanup operation in progress. This hook observes state; use local participant controls to change it.