Olympe SDK

Class: LocalUserStream

olympe.ui.media. LocalUserStream

Locally produced user media stream: typically the webcam.

new LocalUserStream(videoDevice, audioDevice)

Parameters:
Name Type Description
videoDevice olympe.ui.media.devices.VideoInputDevice | olympe.df.Proxy.<olympe.ui.media.devices.VideoInputDevice>
audioDevice olympe.ui.media.devices.AudioInputDevice | olympe.df.Proxy.<olympe.ui.media.devices.AudioInputDevice>

Extends

Methods

<protected> getUIProxyLocalUserStream()

Returns:

The proxy element from the UI thread

Type
olympe.uiapi.media.LocalUserStream

getUIProxyMediaStream()

This method needs to be public for the Video objects to be able to access the UI stream proxy

Inherited From:
Overrides:
Returns:

Native media stream proxy

Type
olympe.uiapi.media.MediaStream

getUIProxyUserStream()

This method needs to be public for the PeerConnection objects to be able to access the UI stream proxy

Inherited From:
Overrides:
Returns:

Native user stream proxy

Type
olympe.uiapi.media.UserStream

initStream()

Thru this method, the initialization of the native implementation of the stream can be forced. A call to this method should typically be followed by a processFlow call on the stream status, to verify if the initialisation has been successful.

isSuccessfullyInitialised()

Returns a boolean dataflow carrying the status of the stream. As long has the dataflow has no current value, the stream should be considered as not fully initialised.

Inherited From:
Overrides:
Returns:
Type
olympe.df.POBoolean

setAudioEnabled(enabled)

Sets whether audio streaming is enabled or not

Parameters:
Name Type Description
enabled boolean

setVideoEnabled(enabled)

Sets whether video streaming is enabled or not

Parameters:
Name Type Description
enabled boolean

takePicture(callback [, pictureSize])

Take a still picture of the stream

Parameters:
Name Type Argument Description
callback olympe.ui.media.MediaStream.PictureTakenCallback

Callback function
pictureSize olympe.df.Vector2 | olympe.df.Proxy.<olympe.df.Vector2> <optional>

If specified, the stream picture will cover the area (aspect ratio is preserved, some cropping my occur)
Inherited From:
Overrides: