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
JavaEE Documentation
VideoStreamingCapability

Class VideoStreamingCapability

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

Contains information about this system's video streaming capabilities.

Fields

KEY_PREFERRED_RESOLUTION

public static final java.lang.String KEY_PREFERRED_RESOLUTION
Constant Value
"preferredResolution"

KEY_MAX_BITRATE

public static final java.lang.String KEY_MAX_BITRATE
Constant Value
"maxBitrate"

KEY_SUPPORTED_FORMATS

public static final java.lang.String KEY_SUPPORTED_FORMATS
Constant Value
"supportedFormats"

KEY_HAPTIC_SPATIAL_DATA_SUPPORTED

public static final java.lang.String KEY_HAPTIC_SPATIAL_DATA_SUPPORTED
Constant Value
"hapticSpatialDataSupported"

KEY_DIAGONAL_SCREEN_SIZE

public static final java.lang.String KEY_DIAGONAL_SCREEN_SIZE
Constant Value
"diagonalScreenSize"

KEY_PIXEL_PER_INCH

public static final java.lang.String KEY_PIXEL_PER_INCH
Constant Value
"pixelPerInch"

KEY_SCALE

public static final java.lang.String KEY_SCALE
Constant Value
"scale"

KEY_PREFERRED_FPS

public static final java.lang.String KEY_PREFERRED_FPS
Constant Value
"preferredFPS"

KEY_ADDITIONAL_VIDEO_STREAMING_CAPABILITIES

public static final java.lang.String KEY_ADDITIONAL_VIDEO_STREAMING_CAPABILITIES
Constant Value
"additionalVideoStreamingCapabilities"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

VideoStreamingCapability()

public VideoStreamingCapability()

VideoStreamingCapability( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

public VideoStreamingCapability(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash

Methods

setPreferredResolution( ImageResolution res )

public com.smartdevicelink.proxy.rpc.VideoStreamingCapability setPreferredResolution(ImageResolution res)

Parameters

res

getPreferredResolution()

public com.smartdevicelink.proxy.rpc.ImageResolution getPreferredResolution()

setMaxBitrate( Integer maxBitrate )

Set the max bitrate supported by this module. NOTE: Unit is in kbps.

public com.smartdevicelink.proxy.rpc.VideoStreamingCapability setMaxBitrate(Integer maxBitrate)

Parameters

maxBitrate
in kbps

getMaxBitrate()

Retrieves the max bitrate supported by this module. NOTE: Unit is in kbps.

public java.lang.Integer getMaxBitrate()

setSupportedFormats( java.util.List<com.smartdevicelink.proxy.rpc.VideoStreamingFormat> formats )

public com.smartdevicelink.proxy.rpc.VideoStreamingCapability setSupportedFormats(java.util.List<com.smartdevicelink.proxy.rpc.VideoStreamingFormat> formats)

Parameters

formats

getSupportedFormats()

public java.util.List getSupportedFormats()

getIsHapticSpatialDataSupported()

Deprecated

public java.lang.Boolean getIsHapticSpatialDataSupported()

setIsHapticSpatialDataSupported( Boolean hapticSpatialDataSupported )

Deprecated

public com.smartdevicelink.proxy.rpc.VideoStreamingCapability setIsHapticSpatialDataSupported(Boolean hapticSpatialDataSupported)

Parameters

hapticSpatialDataSupported

isHapticSpatialDataSupported()

Gets whether the dead unit supports HapticSpatialData

public java.lang.Boolean isHapticSpatialDataSupported()

setHapticSpatialDataSupported( Boolean hapticSpatialDataSupported )

Sets whether the dead unit supports HapticSpatialData

public com.smartdevicelink.proxy.rpc.VideoStreamingCapability setHapticSpatialDataSupported(Boolean hapticSpatialDataSupported)

Parameters

hapticSpatialDataSupported
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.

getDiagonalScreenSize()

public java.lang.Double getDiagonalScreenSize()

setDiagonalScreenSize( Double diagonalScreenSize )

public com.smartdevicelink.proxy.rpc.VideoStreamingCapability setDiagonalScreenSize(Double diagonalScreenSize)

Parameters

diagonalScreenSize
the diagonal screen size in inches.

getPixelPerInch()

public java.lang.Double getPixelPerInch()

setPixelPerInch( Double pixelPerInch )

public com.smartdevicelink.proxy.rpc.VideoStreamingCapability setPixelPerInch(Double pixelPerInch)

Parameters

pixelPerInch
the diagonal resolution in pixels divided by the diagonal screen size in inches.

getScale()

public java.lang.Double getScale()

setScale( Double scale )

public com.smartdevicelink.proxy.rpc.VideoStreamingCapability setScale(Double scale)

Parameters

scale
the scaling factor the app should use to change the size of the projecting view.

getAdditionalVideoStreamingCapabilities()

Gets the additionalVideoStreamingCapabilities.

public java.util.List getAdditionalVideoStreamingCapabilities()

setAdditionalVideoStreamingCapabilities( java.util.List<com.smartdevicelink.proxy.rpc.VideoStreamingCapability> additionalVideoStreamingCapabilities )

Sets the additionalVideoStreamingCapabilities.

public com.smartdevicelink.proxy.rpc.VideoStreamingCapability setAdditionalVideoStreamingCapabilities(java.util.List<com.smartdevicelink.proxy.rpc.VideoStreamingCapability> additionalVideoStreamingCapabilities)

Parameters

additionalVideoStreamingCapabilities
{"array_min_size": 1, "array_max_size": 100}

getPreferredFPS()

public java.lang.Integer getPreferredFPS()

setPreferredFPS( Integer preferredFPS )

public com.smartdevicelink.proxy.rpc.VideoStreamingCapability setPreferredFPS(Integer preferredFPS)

Parameters

preferredFPS
preferred frame rate per second

format( Version rpcVersion, boolean formatParams )

public void format(Version rpcVersion,boolean formatParams)

Parameters

rpcVersion
formatParams

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section