Interface UserMediaStream

Interface for controlling and interacting with a user media stream, including starting, inspecting, stopping the stream, and updating configuration options.

interface UserMediaStream {
    inspect: (() => Promise<undefined | UserMediaStreamCapabilities>);
    setOptions: ((userMediaStreamOptions) => void);
    start: (() => Promise<MediaStream>);
    stop: (() => Promise<void>);
}

Index

Properties

inspect setOptions start stop

Properties

inspect

inspect: (() => Promise<undefined | UserMediaStreamCapabilities>)

Type declaration

- (): Promise<undefined | UserMediaStreamCapabilities>
- Returns Promise<undefined | UserMediaStreamCapabilities>

setOptions

setOptions: ((userMediaStreamOptions) => void)

Type declaration

- (userMediaStreamOptions): void
- Parameters
  - userMediaStreamOptions: UserMediaStreamOptions
  Returns void

start

start: (() => Promise<MediaStream>)

Type declaration

- (): Promise<MediaStream>
- Returns Promise<MediaStream>

stop

stop: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Returns Promise<void>

Generated using TypeDoc