Olympe SDK

Class: UrlStream

olympe.ui.media. UrlStream

URL based media streams.

new UrlStream()

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

getUIProxyUrlStream()

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

Returns:
Type
olympe.uiapi.media.UrlStream

setUrl(url)

Sets the stream's URL

Parameters:
Name Type Description
url string

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: