ToiMediaPlayerBaseVideoStreamInfo Interface Reference

---

Description

This is the documentation for ToiMediaPlayerBaseVideoStreamInfo.
Video stream data structure used to return video stream information. Depending on the stream format some fields will be reported as unknown. The (C++) Encoding field is the only field that will not be reported as unknown if it is not the currently active video stream. Use toi.statics.ToiMediaPlayerBaseVideoStreamInfo.create(<encoding>, <resolutionX>, <resolutionY>, <aspectRatio>, <activeFormatDescriptor>, <frameRate>, <componentTag>, <video3dFormat>) to create an instance of ToiMediaPlayerBaseVideoStreamInfo. The following parameters in the create method are optional: <video3dFormat>. For the optional members that have default values, the values are: ; if they are not set from the portal, they will have the default value.

import "ToiMediaPlayerBaseVideoStreamInfo.idl";

List of all members.

Public Attributes
attribute string	encoding
attribute long	resolutionX
attribute long	resolutionY
attribute ToiMediaPlayerBase::TToiAspectRatio	aspectRatio
attribute ToiMediaPlayerBase::TToiActiveFormatDescriptor	activeFormatDescriptor
attribute long	frameRate
attribute long	componentTag
attribute ToiMediaPlayerBase::TToiVideo3dSourceFormat	video3dFormat

---

Member Data Documentation

attribute ToiMediaPlayerBase::TToiActiveFormatDescriptor ToiMediaPlayerBaseVideoStreamInfo::activeFormatDescriptor

The active format descriptor as specified in ETSI TS 101 154 Annex B. If the active format descriptor is unknown the value will be set to ToiMediaPlayerBase::ACTIVE_FORMAT_UNKNOWN.

attribute ToiMediaPlayerBase::TToiAspectRatio ToiMediaPlayerBaseVideoStreamInfo::aspectRatio

The pel aspect ratio code as specified in ISO/IEC 11172-2 section 2.4.3.2. If the aspect ratio is unknown the value will be set to ToiMediaPlayerBase::ASPECT_RATIO_UNKNOWN.

attribute long ToiMediaPlayerBaseVideoStreamInfo::componentTag

The audio component tag value. The value will be set to -1 if it does not exist for the stream.

attribute string ToiMediaPlayerBaseVideoStreamInfo::encoding

Type of video encoding used. The string is empty if the encoding is unknown. The content of the string is determined by the decoder and is supplied for trouble-shooting reasons.

attribute long ToiMediaPlayerBaseVideoStreamInfo::frameRate

The video frame rate. The frame is in thousands of a frame per second, ie the value will be 25 000 for a frame rate of 25 frames per second. If the frame rate is unknown the value will be set to -1.

attribute long ToiMediaPlayerBaseVideoStreamInfo::resolutionX

The horizontal resolution of the video image in number of pixels. If the horizontal resolution is unknown the value is -1.

attribute long ToiMediaPlayerBaseVideoStreamInfo::resolutionY

The vertical resolution of the video image in number of pixels. If the vertical resolution is unknown the value is -1.

attribute ToiMediaPlayerBase::TToiVideo3dSourceFormat ToiMediaPlayerBaseVideoStreamInfo::video3dFormat

Technical Preview:

This field is a TECHNICAL PREVIEW, it may change. 3D video source format detected in the SEI message