Olympe SDK

Class: UserStream

olympe.ui.media. UserStream

User stream: a media stream produced by a user.

<abstract> new UserStream(uiProxy)

Parameters:
Name Type Description
uiProxy olympe.uiapi.UIElement

Extends

Methods

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

Returns:

Native user stream proxy

Type
olympe.uiapi.media.UserStream

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.

Returns:
Type
olympe.df.POBoolean

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: