Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @pureweb/platform-sdk-react

Index

Type aliases

LaunchRequestOptions

LaunchRequestOptions: { regionOverride?: string }

Type declaration

  • Optional regionOverride?: string

Variables

Const IdleTimeout

IdleTimeout: React.FC<TimeoutProps> = ...

Const VideoStream

VideoStream: React.FC<VideoStreamProps> = ...

Functions

messagingStatusHook

  • messagingStatusHook(platform: PlatformNext): readonly [string]
  • Parameters

    • platform: PlatformNext

    Returns readonly [string]

Const useLaunchRequest

  • useLaunchRequest(platform: PlatformNext, md: ModelDefinition | UndefinedModelDefinition, options?: LaunchRequestOptions): readonly [LaunchStatusEvent, ILaunchRequest, () => void]
  • Parameters

    • platform: PlatformNext
    • md: ModelDefinition | UndefinedModelDefinition
    • Optional options: LaunchRequestOptions

    Returns readonly [LaunchStatusEvent, ILaunchRequest, () => void]

useStreamer

  • useStreamer(platform: PlatformNext, launchRequest?: ILaunchRequest, options?: StreamerOptions, contributionFilter?: IContributionFilter): readonly [StreamerStatus, InputEmitter, MediaStream, MediaStream, Subject<string>]
  • Creates a WebRTC-based Streaming Interface.

    Parameters

    • platform: PlatformNext
    • Optional launchRequest: ILaunchRequest
    • Optional options: StreamerOptions

      Optional options to customize the streamer

    • Optional contributionFilter: IContributionFilter

    Returns readonly [StreamerStatus, InputEmitter, MediaStream, MediaStream, Subject<string>]

Generated using TypeDoc