VideoStreamingCapability (sdl

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.rpc.VideoStreamingCapability

All Implemented Interfaces:

Cloneable
```
public class VideoStreamingCapability
extends RPCStruct
```
Contains information about this system's video streaming capabilities.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_ADDITIONAL_VIDEO_STREAMING_CAPABILITIES`
`static String`	`KEY_DIAGONAL_SCREEN_SIZE`
`static String`	`KEY_HAPTIC_SPATIAL_DATA_SUPPORTED`
`static String`	`KEY_MAX_BITRATE`
`static String`	`KEY_PIXEL_PER_INCH`
`static String`	`KEY_PREFERRED_FPS`
`static String`	`KEY_PREFERRED_RESOLUTION`
`static String`	`KEY_SCALE`
`static String`	`KEY_SUPPORTED_FORMATS`

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description

VideoStreamingCapability()

VideoStreamingCapability(Hashtable<String,Object> hash)

Constructors
Constructor and Description
`VideoStreamingCapability()`
`VideoStreamingCapability(Hashtable<String,Object> hash)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`format(Version rpcVersion, boolean formatParams)` This method should clean the the RPC to make sure it is compliant with the spec.
`List<VideoStreamingCapability>`	`getAdditionalVideoStreamingCapabilities()` Gets the additionalVideoStreamingCapabilities.
`Double`	`getDiagonalScreenSize()`
`Boolean`	`getIsHapticSpatialDataSupported()` Deprecated. use `isHapticSpatialDataSupported()` instead.
`Integer`	`getMaxBitrate()` Retrieves the max bitrate supported by this module.
`Double`	`getPixelPerInch()`
`Integer`	`getPreferredFPS()`
`ImageResolution`	`getPreferredResolution()`
`Double`	`getScale()`
`List<VideoStreamingFormat>`	`getSupportedFormats()`
`Boolean`	`isHapticSpatialDataSupported()` Gets whether the dead unit supports HapticSpatialData
`VideoStreamingCapability`	`setAdditionalVideoStreamingCapabilities(List<VideoStreamingCapability> additionalVideoStreamingCapabilities)` Sets the additionalVideoStreamingCapabilities.
`VideoStreamingCapability`	`setDiagonalScreenSize(Double diagonalScreenSize)`
`VideoStreamingCapability`	`setHapticSpatialDataSupported(Boolean hapticSpatialDataSupported)` Sets whether the dead unit supports HapticSpatialData
`VideoStreamingCapability`	`setIsHapticSpatialDataSupported(Boolean hapticSpatialDataSupported)` Deprecated. use `setHapticSpatialDataSupported(Boolean hapticSpatialDataSupported)` instead.
`VideoStreamingCapability`	`setMaxBitrate(Integer maxBitrate)` Set the max bitrate supported by this module.
`VideoStreamingCapability`	`setPixelPerInch(Double pixelPerInch)`
`VideoStreamingCapability`	`setPreferredFPS(Integer preferredFPS)`
`VideoStreamingCapability`	`setPreferredResolution(ImageResolution res)`
`VideoStreamingCapability`	`setScale(Double scale)`
`VideoStreamingCapability`	`setSupportedFormats(List<VideoStreamingFormat> formats)`

Methods inherited from class com.smartdevicelink.proxy.RPCStruct
clone, deserializeJSON, equals, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_PREFERRED_RESOLUTION
```
public static final String KEY_PREFERRED_RESOLUTION
```
    See Also:
    
    Constant Field Values
  - KEY_MAX_BITRATE
```
public static final String KEY_MAX_BITRATE
```
    See Also:
    
    Constant Field Values
  - KEY_SUPPORTED_FORMATS
```
public static final String KEY_SUPPORTED_FORMATS
```
    See Also:
    
    Constant Field Values
  - KEY_HAPTIC_SPATIAL_DATA_SUPPORTED
```
public static final String KEY_HAPTIC_SPATIAL_DATA_SUPPORTED
```
    See Also:
    
    Constant Field Values
  - KEY_DIAGONAL_SCREEN_SIZE
```
public static final String KEY_DIAGONAL_SCREEN_SIZE
```
    See Also:
    
    Constant Field Values
  - KEY_PIXEL_PER_INCH
```
public static final String KEY_PIXEL_PER_INCH
```
    See Also:
    
    Constant Field Values
  - KEY_SCALE
```
public static final String KEY_SCALE
```
    See Also:
    
    Constant Field Values
  - KEY_PREFERRED_FPS
```
public static final String KEY_PREFERRED_FPS
```
    See Also:
    
    Constant Field Values
  - KEY_ADDITIONAL_VIDEO_STREAMING_CAPABILITIES
```
public static final String KEY_ADDITIONAL_VIDEO_STREAMING_CAPABILITIES
```
    Since:
    
    SmartDeviceLink 7.1.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VideoStreamingCapability
```
public VideoStreamingCapability()
```
  - VideoStreamingCapability
```
public VideoStreamingCapability(Hashtable<String,Object> hash)
```
- Method Detail
  - setPreferredResolution
```
public VideoStreamingCapability setPreferredResolution(ImageResolution res)
```
  - getPreferredResolution
```
public ImageResolution getPreferredResolution()
```
  - setMaxBitrate
```
public VideoStreamingCapability setMaxBitrate(Integer maxBitrate)
```
    Set the max bitrate supported by this module. NOTE: Unit is in kbps.
    
    Parameters:
    
    maxBitrate - in kbps
  - getMaxBitrate
```
public Integer getMaxBitrate()
```
    Retrieves the max bitrate supported by this module. NOTE: Unit is in kbps.
    
    Returns:
    
    max bitrate in kbps
  - setSupportedFormats
```
public VideoStreamingCapability setSupportedFormats(List<VideoStreamingFormat> formats)
```
  - getSupportedFormats
```
public List<VideoStreamingFormat> getSupportedFormats()
```
  - getIsHapticSpatialDataSupported
```
@Deprecated
public Boolean getIsHapticSpatialDataSupported()
```
    Deprecated. use isHapticSpatialDataSupported() instead.
  - setIsHapticSpatialDataSupported
```
@Deprecated
public VideoStreamingCapability setIsHapticSpatialDataSupported(Boolean hapticSpatialDataSupported)
```
    Deprecated. use setHapticSpatialDataSupported(Boolean hapticSpatialDataSupported) instead.
  - isHapticSpatialDataSupported
```
public Boolean isHapticSpatialDataSupported()
```
    Gets whether the dead unit supports HapticSpatialData
    
    Returns:
    
    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.
  - setHapticSpatialDataSupported
```
public VideoStreamingCapability setHapticSpatialDataSupported(Boolean hapticSpatialDataSupported)
```
    Sets whether the dead unit supports HapticSpatialData
    
    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 Double getDiagonalScreenSize()
```
    Returns:
    
    the diagonal screen size in inches.
  - setDiagonalScreenSize
```
public VideoStreamingCapability setDiagonalScreenSize(Double diagonalScreenSize)
```
    Parameters:
    
    diagonalScreenSize - the diagonal screen size in inches.
  - getPixelPerInch
```
public Double getPixelPerInch()
```
    Returns:
    
    the diagonal resolution in pixels divided by the diagonal screen size in inches.
  - setPixelPerInch
```
public VideoStreamingCapability setPixelPerInch(Double pixelPerInch)
```
    Parameters:
    
    pixelPerInch - the diagonal resolution in pixels divided by the diagonal screen size in inches.
  - getScale
```
public Double getScale()
```
    Returns:
    
    the scaling factor the app should use to change the size of the projecting view.
  - setScale
```
public VideoStreamingCapability setScale(Double scale)
```
    Parameters:
    
    scale - the scaling factor the app should use to change the size of the projecting view.
  - getAdditionalVideoStreamingCapabilities
```
public List<VideoStreamingCapability> getAdditionalVideoStreamingCapabilities()
```
    Gets the additionalVideoStreamingCapabilities.
    
    Returns:
    
    List {"array_min_size": 1, "array_max_size": 100}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - setAdditionalVideoStreamingCapabilities
```
public VideoStreamingCapability setAdditionalVideoStreamingCapabilities(List<VideoStreamingCapability> additionalVideoStreamingCapabilities)
```
    Sets the additionalVideoStreamingCapabilities.
    
    Parameters:
    
    additionalVideoStreamingCapabilities - {"array_min_size": 1, "array_max_size": 100}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - getPreferredFPS
```
public Integer getPreferredFPS()
```
    Returns:
    
    the preferred frame rate per second (FPS) specified by head unit.
  - setPreferredFPS
```
public VideoStreamingCapability setPreferredFPS(Integer preferredFPS)
```
    Parameters:
    
    preferredFPS - preferred frame rate per second
  - format
```
public void format(Version rpcVersion,
                   boolean formatParams)
```
    Description copied from class: RPCStruct
    
    This method should clean the the RPC to make sure it is compliant with the spec.
    
    NOTE: Super needs to be called at the END of the method
    
    Overrides:
    
    format in class RPCStruct
    
    Parameters:
    
    rpcVersion - the rpc spec version that has been negotiated. If value is null the the max value of RPC spec version this library supports should be used.
    
    formatParams - if true, the format method will be called on subsequent params

Class VideoStreamingCapability

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_PREFERRED_RESOLUTION

KEY_MAX_BITRATE

KEY_SUPPORTED_FORMATS

KEY_HAPTIC_SPATIAL_DATA_SUPPORTED

KEY_DIAGONAL_SCREEN_SIZE

KEY_PIXEL_PER_INCH

KEY_SCALE

KEY_PREFERRED_FPS

KEY_ADDITIONAL_VIDEO_STREAMING_CAPABILITIES

Constructor Detail

VideoStreamingCapability

VideoStreamingCapability

Method Detail

setPreferredResolution

getPreferredResolution

setMaxBitrate

getMaxBitrate

setSupportedFormats

getSupportedFormats

getIsHapticSpatialDataSupported

setIsHapticSpatialDataSupported

isHapticSpatialDataSupported

setHapticSpatialDataSupported

getDiagonalScreenSize

setDiagonalScreenSize

getPixelPerInch

setPixelPerInch

getScale

setScale

getAdditionalVideoStreamingCapabilities

setAdditionalVideoStreamingCapabilities

getPreferredFPS

setPreferredFPS

format