CameraAvStreamManagementTrait.VideoStreamStruct
class CameraAvStreamManagementTrait.VideoStreamStruct : ClusterStruct
Captures all parameters of a video stream.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this struct's fields. |
Public constructors |
|---|
VideoStreamStruct(Creates the VideoStreamStruct class. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
UShort |
|
UInt |
The maximum bitrate for the corresponding video stream in bits per second. |
UShort |
|
CameraAvStreamManagementTrait.VideoResolutionStruct |
|
UInt |
The minimum bitrate for the corresponding video stream in bits per second. |
UShort |
|
CameraAvStreamManagementTrait.VideoResolutionStruct |
|
OptionalValue<Boolean> |
|
UByte |
|
CameraAvStreamManagementTrait.StreamUsageEnum |
The usage of the stream as described in |
CameraAvStreamManagementTrait.VideoCodecEnum |
|
UShort |
The uniquely allocated identifier for the video stream. |
OptionalValue<Boolean> |
Public constructors
VideoStreamStruct
VideoStreamStruct(
videoStreamId: UShort,
streamUsage: CameraAvStreamManagementTrait.StreamUsageEnum = StreamUsageEnum.Internal,
videoCodec: CameraAvStreamManagementTrait.VideoCodecEnum = VideoCodecEnum.H264,
minFrameRate: UShort,
maxFrameRate: UShort,
minResolution: CameraAvStreamManagementTrait.VideoResolutionStruct = VideoResolutionStruct(),
maxResolution: CameraAvStreamManagementTrait.VideoResolutionStruct = VideoResolutionStruct(),
minBitRate: UInt,
maxBitRate: UInt,
keyFrameInterval: UShort,
watermarkEnabled: OptionalValue<Boolean> = OptionalValue.absent(),
osdEnabled: OptionalValue<Boolean> = OptionalValue.absent(),
referenceCount: UByte
)
Creates the VideoStreamStruct class.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
maxBitRate
val maxBitRate: UInt
The maximum bitrate for the corresponding video stream in bits per second.
minBitRate
val minBitRate: UInt
The minimum bitrate for the corresponding video stream in bits per second.
streamUsage
val streamUsage: CameraAvStreamManagementTrait.StreamUsageEnum
The usage of the stream as described in StreamUsageEnum.