• Preparing search index...
  • The search index is not available
@bengreenier/react-user-media
  • @bengreenier/react-user-media
  • useMedia

Function useMedia

  • useMedia<TType>(type): inferMediaDef<TType>["stateType"]
  • Hook that allows the caller to obtain and manage media on behalf of the user.

    Most commonly, this is used to access webcams, microphones, or mirrored media.

    Type Parameters

    • TType extends "user" | "display"

    Parameters

    • type: TType

      the type of media to use.

      • user causes media to be obtained via https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia|getUserMedia
      • display causes media to be obtained via https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia|getDisplayMedia

    Returns inferMediaDef<TType>["stateType"]

    see UserMediaState and DisplayMediaState for more information.

    • Defined in hooks/use-media.ts:181

Settings

Member Visibility
@bengreenier/react-user-media
  • Loading...

Generated using TypeDoc with typedoc-github-theme