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
iOS Documentation
SDLVideoStreamingCapability

SDLVideoStreamingCapability Class Reference

Section Contents

Overview

Contains information about this system’s video streaming capabilities

-initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:diagonalScreenSize:pixelPerInch:scale:

Convenience init for creating a video streaming capability with all parameters.

Objective-C

- (nonnull instancetype)
    initWithPreferredResolution:
        (nullable SDLImageResolution *)preferredResolution
                     maxBitrate:(int32_t)maxBitrate
               supportedFormats:(nullable NSArray<SDLVideoStreamingFormat *> *)
                                    supportedFormats
            hapticDataSupported:(BOOL)hapticDataSupported
             diagonalScreenSize:(float)diagonalScreenSize
                   pixelPerInch:(float)pixelPerInch
                          scale:(float)scale;

Swift

init(preferredResolution: SDLImageResolution?, maxBitrate: Int32, supportedFormats: [SDLVideoStreamingFormat]?, hapticDataSupported: Bool, diagonalScreenSize: Float, pixelPerInch: Float, scale: Float)

Parameters

preferredResolution

The preferred resolution of a video stream for decoding and rendering on HMI

maxBitrate

The maximum bitrate of video stream that is supported, in kbps

supportedFormats

Detailed information on each format supported by this system, in its preferred order

hapticDataSupported

True if the system can utilize the haptic spatial data from the source being streamed

diagonalScreenSize

The diagonal screen size in inches

pixelPerInch

The diagonal resolution in pixels divided by the diagonal screen size in inches

scale

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

Return Value

A SDLVideoStreamingCapability object

-initWithPreferredResolution:maxBitrate:supportedFormats:hapticSpatialDataSupported:diagonalScreenSize:pixelPerInch:scale:preferredFPS:

Convenience init for creating a video streaming capability with all parameters.

Objective-C

- (nonnull instancetype)
    initWithPreferredResolution:
        (nullable SDLImageResolution *)preferredResolution
                     maxBitrate:(nullable NSNumber<SDLUInt> *)maxBitrate
               supportedFormats:(nullable NSArray<SDLVideoStreamingFormat *> *)
                                    supportedFormats
     hapticSpatialDataSupported:
         (nullable NSNumber<SDLBool> *)hapticSpatialDataSupported
             diagonalScreenSize:
                 (nullable NSNumber<SDLFloat> *)diagonalScreenSize
                   pixelPerInch:(nullable NSNumber<SDLFloat> *)pixelPerInch
                          scale:(nullable NSNumber<SDLFloat> *)scale
                   preferredFPS:(nullable NSNumber<SDLUInt> *)preferredFPS;

Swift

init(preferredResolution: SDLImageResolution?, maxBitrate: (NSNumber & SDLUInt)?, supportedFormats: [SDLVideoStreamingFormat]?, hapticSpatialDataSupported: (NSNumber & SDLBool)?, diagonalScreenSize: (NSNumber & SDLFloat)?, pixelPerInch: (NSNumber & SDLFloat)?, scale: (NSNumber & SDLFloat)?, preferredFPS: (NSNumber & SDLUInt)?)

Parameters

preferredResolution

- preferredResolution

maxBitrate

- maxBitrate

supportedFormats

- supportedFormats

hapticSpatialDataSupported

- hapticSpatialDataSupported

diagonalScreenSize

- diagonalScreenSize

pixelPerInch

- pixelPerInch

scale

- scale

preferredFPS

- preferredFPS

Return Value

A SDLVideoStreamingCapability object

preferredResolution

The preferred resolution of a video stream for decoding and rendering on HMI

Optional

Objective-C

@property (nonatomic, strong, nullable) SDLImageResolution *preferredResolution;

Swift

var preferredResolution: SDLImageResolution? { get set }

maxBitrate

The maximum bitrate of video stream that is supported, in kbps, optional

Optional, minvalue= 0, maxvalue= 2147483647

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLInt> *maxBitrate;

Swift

var maxBitrate: (NSNumber & SDLInt)? { get set }

supportedFormats

Detailed information on each format supported by this system, in its preferred order

Optional

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLVideoStreamingFormat *> *supportedFormats;

Swift

var supportedFormats: [SDLVideoStreamingFormat]? { get set }

hapticSpatialDataSupported

True if the system can utilize the haptic spatial data from the source being streamed.

Optional

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLBool> *hapticSpatialDataSupported;

Swift

var hapticSpatialDataSupported: (NSNumber & SDLBool)? { get set }

diagonalScreenSize

The diagonal screen size in inches.

Float, Optional, minvalue=“0” @since SDL 6.0

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLFloat> *diagonalScreenSize;

Swift

var diagonalScreenSize: (NSNumber & SDLFloat)? { get set }

pixelPerInch

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

Float, Optional, minvalue=“0” @since SDL 6.0

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLFloat> *pixelPerInch;

Swift

var pixelPerInch: (NSNumber & SDLFloat)? { get set }

scale

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

Float, Optional, minvalue=“1” maxvalue=“10” @since SDL 6.0

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLFloat> *scale;

Swift

var scale: (NSNumber & SDLFloat)? { get set }

additionalVideoStreamingCapabilities

{“array_min_size”: 1, “array_max_size”: 100}

@added in SmartDeviceLink 7.1.0

Note

can be recursive under certain circumstances

Objective-C

@property (nonatomic, strong, nullable) NSArray<SDLVideoStreamingCapability *> *additionalVideoStreamingCapabilities;

Swift

var additionalVideoStreamingCapabilities: [SDLVideoStreamingCapability]? { get set }

preferredFPS

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. {“num_min_value”: 0, “num_max_value”: 2147483647}

@added in SmartDeviceLink 7.1.0

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLUInt> *preferredFPS;

Swift

var preferredFPS: (NSNumber & SDLUInt)? { get set }
View on GitHub.com
Previous Section Next Section