Array.<VideoStreamingCapability>
Number
Boolean
Number
Number
Number
ImageResolution
Number
Array.<VideoStreamingFormat>
VideoStreamingCapability
VideoStreamingCapability
VideoStreamingCapability
VideoStreamingCapability
VideoStreamingCapability
VideoStreamingCapability
VideoStreamingCapability
VideoStreamingCapability
VideoStreamingCapability
Initializes an instance of VideoStreamingCapability.
Array.<VideoStreamingCapability>
Get the AdditionalVideoStreamingCapabilities
Kind: Instance method of VideoStreamingCapability
Returns: Array.<VideoStreamingCapability>
- the KEY_ADDITIONAL_VIDEO_STREAMING_CAPABILITIES value
Number
Get the DiagonalScreenSize
Kind: Instance method of VideoStreamingCapability
Returns: Number
- the KEY_DIAGONAL_SCREEN_SIZE value
Boolean
Get the HapticSpatialDataSupported
Kind: Instance method of VideoStreamingCapability
Returns: Boolean
- the KEY_HAPTIC_SPATIAL_DATA_SUPPORTED value
Number
Get the MaxBitrate
Kind: Instance method of VideoStreamingCapability
Returns: Number
- the KEY_MAX_BITRATE value
Number
Get the PixelPerInch
Kind: Instance method of VideoStreamingCapability
Returns: Number
- the KEY_PIXEL_PER_INCH value
Number
Get the PreferredFPS
Kind: Instance method of VideoStreamingCapability
Returns: Number
- the KEY_PREFERRED_FPS value
ImageResolution
Get the PreferredResolution
Kind: Instance method of VideoStreamingCapability
Returns: ImageResolution
- the KEY_PREFERRED_RESOLUTION value
Number
Get the Scale
Kind: Instance method of VideoStreamingCapability
Returns: Number
- the KEY_SCALE value
Array.<VideoStreamingFormat>
Get the SupportedFormats
Kind: Instance method of VideoStreamingCapability
Returns: Array.<VideoStreamingFormat>
- the KEY_SUPPORTED_FORMATS value
VideoStreamingCapability
Set the AdditionalVideoStreamingCapabilities
Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
capabilities | Array.<VideoStreamingCapability> |
Contains information about this system's video streaming capabilities. - The desired AdditionalVideoStreamingCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
VideoStreamingCapability
Set the DiagonalScreenSize
Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
size | Number |
The diagonal screen size in inches. - The desired DiagonalScreenSize. {'num_min_value': 0.0} |
VideoStreamingCapability
Set the HapticSpatialDataSupported
Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
supported | Boolean |
True if the system can utilize the haptic spatial data from the source being streamed. If not included, it can be assumed the module doesn't support haptic spatial data'. - The desired HapticSpatialDataSupported. |
VideoStreamingCapability
Set the MaxBitrate
Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
bitrate | Number |
The maximum bitrate of video stream that is supported, in kbps. - The desired MaxBitrate. {'num_min_value': 0, 'num_max_value': 2147483647} |
VideoStreamingCapability
Set the PixelPerInch
Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
inch | Number |
PPI is the diagonal resolution in pixels divided by the diagonal screen size in inches. - The desired PixelPerInch. {'num_min_value': 0.0} |
VideoStreamingCapability
Set the PreferredFPS
Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
fps | Number |
The preferred frame rate per second of the head unit. The mobile application / app library may take other factors into account that constrain the frame rate lower than this value, but it should not perform streaming at a higher frame rate than this value. - The desired PreferredFPS. {'num_min_value': 0, 'num_max_value': 2147483647} |
VideoStreamingCapability
Set the PreferredResolution
Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
resolution | ImageResolution |
The preferred resolution of a video stream for decoding and rendering on HMI. - The desired PreferredResolution. |
VideoStreamingCapability
Set the Scale
Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
scale | Number |
The scaling factor the app should use to change the size of the projecting view. - The desired Scale. {'num_min_value': 1.0, 'num_max_value': 10.0} |
VideoStreamingCapability
Set the SupportedFormats
Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability
- The class instance for method chaining.
Param | Type | Description |
---|---|---|
formats | Array.<VideoStreamingFormat> |
Detailed information on each format supported by this system, in its preferred order (i.e. the first element in the array is most preferable to the system). Each object will contain a VideoStreamingFormat that describes what can be expected. - The desired SupportedFormats. |