API reference

StreamConfiguration Class

Modifiers: final
Configuration for a media streaming session with a Meta Wearables device. Defines the video quality and other streaming parameters.

See Also

  • StreamSession for the streaming API that uses this configuration
  • VideoQuality for available quality presets
  • Wearables.startStreamSession to create a session with this configuration

Signature

data class StreamConfiguration(val videoQuality: VideoQuality = VideoQuality.MEDIUM, val frameRate: Int = 24, val compressVideo: Boolean = false)

Constructors

StreamConfiguration ( videoQuality , frameRate , compressVideo )
Signature 
constructor(videoQuality: VideoQuality = VideoQuality.MEDIUM, frameRate: Int = 24, compressVideo: Boolean = false)
Parameters
videoQuality: VideoQuality  The video quality setting for the streaming session
frameRate: Int  The desired frame rate for the streaming session. Accepted values: 2, 7, 15, 24, 30
compressVideo: Boolean  When true, the SDK skips decoding and delivers compressed HEVC buffers. When false (default), the SDK decodes internally and delivers YUV pixel buffers.
Returns
StreamConfiguration

Properties

compressVideo : Boolean
[Get]
When true, the SDK skips decoding and delivers compressed HEVC buffers. When false (default), the SDK decodes internally and delivers YUV pixel buffers.
Signature 
val compressVideo: Boolean = false
frameRate : Int
[Get]
The desired frame rate for the streaming session. Accepted values: 2, 7, 15, 24, 30
Signature 
val frameRate: Int = 24
videoQuality : VideoQuality
[Get]
The video quality setting for the streaming session
Signature 
val videoQuality: VideoQuality