Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaScript Suite Documentation
VideoStreamingCapability

VideoStreamingCapability Class Reference

Constructors

Instance Methods

Constructors

new VideoStreamingCapability(parameters)

Initializes an instance of VideoStreamingCapability.

Instance Methods

videoStreamingCapability.getAdditionalVideoStreamingCapabilities() ⇒ Array.<VideoStreamingCapability>

Get the AdditionalVideoStreamingCapabilities

Kind: Instance method of VideoStreamingCapability
Returns: Array.<VideoStreamingCapability> - the KEY_ADDITIONAL_VIDEO_STREAMING_CAPABILITIES value

videoStreamingCapability.getDiagonalScreenSize() ⇒ Number

Get the DiagonalScreenSize

Kind: Instance method of VideoStreamingCapability
Returns: Number - the KEY_DIAGONAL_SCREEN_SIZE value

videoStreamingCapability.getHapticSpatialDataSupported() ⇒ Boolean

Get the HapticSpatialDataSupported

Kind: Instance method of VideoStreamingCapability
Returns: Boolean - the KEY_HAPTIC_SPATIAL_DATA_SUPPORTED value

videoStreamingCapability.getMaxBitrate() ⇒ Number

Get the MaxBitrate

Kind: Instance method of VideoStreamingCapability
Returns: Number - the KEY_MAX_BITRATE value

videoStreamingCapability.getPixelPerInch() ⇒ Number

Get the PixelPerInch

Kind: Instance method of VideoStreamingCapability
Returns: Number - the KEY_PIXEL_PER_INCH value

videoStreamingCapability.getPreferredFPS() ⇒ Number

Get the PreferredFPS

Kind: Instance method of VideoStreamingCapability
Returns: Number - the KEY_PREFERRED_FPS value

videoStreamingCapability.getPreferredResolution() ⇒ ImageResolution

Get the PreferredResolution

Kind: Instance method of VideoStreamingCapability
Returns: ImageResolution - the KEY_PREFERRED_RESOLUTION value

videoStreamingCapability.getScale() ⇒ Number

Get the Scale

Kind: Instance method of VideoStreamingCapability
Returns: Number - the KEY_SCALE value

videoStreamingCapability.getSupportedFormats() ⇒ Array.<VideoStreamingFormat>

Get the SupportedFormats

Kind: Instance method of VideoStreamingCapability
Returns: Array.<VideoStreamingFormat> - the KEY_SUPPORTED_FORMATS value

videoStreamingCapability.setAdditionalVideoStreamingCapabilities(capabilities) ⇒ VideoStreamingCapability

Set the AdditionalVideoStreamingCapabilities

Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability - The class instance for method chaining.

ParamTypeDescription
capabilities Array.<VideoStreamingCapability> Contains information about this system's video streaming capabilities. - The desired AdditionalVideoStreamingCapabilities. {'array_min_size': 1, 'array_max_size': 100}

videoStreamingCapability.setDiagonalScreenSize(size) ⇒ VideoStreamingCapability

Set the DiagonalScreenSize

Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability - The class instance for method chaining.

ParamTypeDescription
size Number The diagonal screen size in inches. - The desired DiagonalScreenSize. {'num_min_value': 0.0}

videoStreamingCapability.setHapticSpatialDataSupported(supported) ⇒ VideoStreamingCapability

Set the HapticSpatialDataSupported

Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability - The class instance for method chaining.

ParamTypeDescription
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.setMaxBitrate(bitrate) ⇒ VideoStreamingCapability

Set the MaxBitrate

Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability - The class instance for method chaining.

ParamTypeDescription
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.setPixelPerInch(inch) ⇒ VideoStreamingCapability

Set the PixelPerInch

Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability - The class instance for method chaining.

ParamTypeDescription
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.setPreferredFPS(fps) ⇒ VideoStreamingCapability

Set the PreferredFPS

Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability - The class instance for method chaining.

ParamTypeDescription
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.setPreferredResolution(resolution) ⇒ VideoStreamingCapability

Set the PreferredResolution

Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability - The class instance for method chaining.

ParamTypeDescription
resolution ImageResolution The preferred resolution of a video stream for decoding and rendering on HMI. - The desired PreferredResolution.

videoStreamingCapability.setScale(scale) ⇒ VideoStreamingCapability

Set the Scale

Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability - The class instance for method chaining.

ParamTypeDescription
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.setSupportedFormats(formats) ⇒ VideoStreamingCapability

Set the SupportedFormats

Kind: Instance method of VideoStreamingCapability
Returns: VideoStreamingCapability - The class instance for method chaining.

ParamTypeDescription
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.
View on GitHub.com
Previous Section Next Section