Skip to main content
Version: Next

Type Alias: LivestreamStreamerProps

LivestreamStreamerProps = object

Defined in: packages/react-native-client/src/components/LivestreamStreamer.tsx:16

Props of the LivestreamView component

Properties

audioEnabled

audioEnabled: boolean

Defined in: packages/react-native-client/src/components/LivestreamStreamer.tsx:28

If audio track should be enabled.


camera?

optional camera: Camera

Defined in: packages/react-native-client/src/components/LivestreamStreamer.tsx:33

Camera to use for the livestream. Use cameras to get the list of supported cameras.


preferredAudioCodecs?

optional preferredAudioCodecs: SenderAudioCodecName[]

Defined in: packages/react-native-client/src/components/LivestreamStreamer.tsx:47

Set the preferred audio codecs for sending the audio. Use WhipClient.getSupportedAudioCodecs to get the list of supported audio codecs.


preferredVideoCodecs?

optional preferredVideoCodecs: SenderVideoCodecName[]

Defined in: packages/react-native-client/src/components/LivestreamStreamer.tsx:42

Set the preferred video codecs for sending the video. Use WhipClient.getSupportedVideoCodecs to get the list of supported video codecs.


style?

optional style: StyleProp<ViewStyle>

Defined in: packages/react-native-client/src/components/LivestreamStreamer.tsx:20

Styles of the LivestreamView component


videoEnabled

videoEnabled: boolean

Defined in: packages/react-native-client/src/components/LivestreamStreamer.tsx:24

If video track should be enabled.


videoParameters?

optional videoParameters: VideoParameters

Defined in: packages/react-native-client/src/components/LivestreamStreamer.tsx:37

Set video parameters for the camera


whipClientRef

whipClientRef: React.RefObject<WhipClient | null>

Defined in: packages/react-native-client/src/components/LivestreamStreamer.tsx:52

Reference to the WhipClient instance. Needs to be passed from the useLivestreamStreamer hook.