ARDSettingsModel Class Reference

#import <ARDSettingsModel.h>

Inheritance diagram for ARDSettingsModel:

Instance Methods
(NSArray< NSString * > *)	- availableVideoResoultionsMediaConstraints
(NSString *)	- currentVideoResoultionConstraintFromStore
(BOOL)	- storeVideoResoultionConstraint:
(nullable NSDictionary *)	- currentMediaConstraintFromStoreAsRTCDictionary
(nullable NSNumber *)	- currentMaxBitrateSettingFromStore
(void)	- storeMaxBitrateSetting:
(NSArray< NSString * > *)	- availableVideoResoultionsMediaConstraints
(NSString *)	- currentVideoResoultionConstraintFromStore
(BOOL)	- storeVideoResoultionConstraint:
(nullable NSDictionary *)	- currentMediaConstraintFromStoreAsRTCDictionary
(nullable NSNumber *)	- currentMaxBitrateSettingFromStore
(void)	- storeMaxBitrateSetting:
(ARDSettingsStore *)	- settingsStore [implementation]
(ARDSettingsStore *)	- settingsStore [implementation]
(nullable NSString *)	- currentVideoResolutionWidthFromStore [implementation]
(nullable NSString *)	- currentVideoResolutionWidthFromStore [implementation]
(nullable NSString *)	- currentVideoResolutionHeightFromStore [implementation]
(nullable NSString *)	- currentVideoResolutionHeightFromStore [implementation]

Protected Attributes
ARDSettingsStore *	_settingsStore

Detailed Description

Model class for user defined settings.

Currently used for streaming media constraints and bitrate only. In future audio media constraints support can be added as well. Offers list of avaliable video resolutions that can construct streaming media constraint. Exposes methods for reading and storing media constraints from persistent store. Also translates current user defined media constraint into RTCMediaConstraints dictionary.

Method Documentation

availableVideoResoultionsMediaConstraints() [1/2]

- (NSArray< NSString * > *) availableVideoResoultionsMediaConstraints

Returns array of available capture resoultions.

The capture resolutions are represented as strings in the following format [width]x[height]

availableVideoResoultionsMediaConstraints() [2/2]

- (NSArray<NSString *> *) availableVideoResoultionsMediaConstraints

Returns array of available capture resoultions.

The capture resolutions are represented as strings in the following format [width]x[height]

currentMaxBitrateSettingFromStore() [1/2]

- (nullable NSNumber *) currentMaxBitrateSettingFromStore

Returns current max bitrate setting from store if present.

currentMaxBitrateSettingFromStore() [2/2]

- (nullable NSNumber *) currentMaxBitrateSettingFromStore

Returns current max bitrate setting from store if present.

currentMediaConstraintFromStoreAsRTCDictionary() [1/2]

- (nullable NSDictionary *) currentMediaConstraintFromStoreAsRTCDictionary

Converts the current media constraints from store into dictionary with RTCMediaConstraints values.

Returns

NSDictionary with RTC width and height parameters

currentMediaConstraintFromStoreAsRTCDictionary() [2/2]

- (nullable NSDictionary *) currentMediaConstraintFromStoreAsRTCDictionary

Converts the current media constraints from store into dictionary with RTCMediaConstraints values.

Returns

NSDictionary with RTC width and height parameters

currentVideoResolutionHeightFromStore() [1/2]

- (nullable NSString *) currentVideoResolutionHeightFromStore

implementation

currentVideoResolutionHeightFromStore() [2/2]

- (nullable NSString *) currentVideoResolutionHeightFromStore

implementation

currentVideoResolutionWidthFromStore() [1/2]

- (nullable NSString *) currentVideoResolutionWidthFromStore

implementation

currentVideoResolutionWidthFromStore() [2/2]

- (nullable NSString *) currentVideoResolutionWidthFromStore

implementation

currentVideoResoultionConstraintFromStore() [1/2]

- (NSString *) currentVideoResoultionConstraintFromStore

Returns current video resolution media constraint string. If no constraint is in store, default value of 640x480 is returned. When defaulting to value, the default is saved in store for consistency reasons.

currentVideoResoultionConstraintFromStore() [2/2]

- (NSString *) currentVideoResoultionConstraintFromStore

Returns current video resolution media constraint string. If no constraint is in store, default value of 640x480 is returned. When defaulting to value, the default is saved in store for consistency reasons.

settingsStore() [1/2]

- (ARDSettingsStore *) settingsStore

implementation

settingsStore() [2/2]

- (ARDSettingsStore *) settingsStore

implementation

storeMaxBitrateSetting:() [1/2]

- (void) storeMaxBitrateSetting:

(nullable NSNumber *)

bitrate

Stores the provided bitrate value into the store.

Parameters

bitrate

NSNumber representation of the max bitrate value.

storeMaxBitrateSetting:() [2/2]

- (void) storeMaxBitrateSetting:

(nullable NSNumber *)

bitrate

Stores the provided bitrate value into the store.

Parameters

bitrate

NSNumber representation of the max bitrate value.

storeVideoResoultionConstraint:() [1/2]

- (BOOL) storeVideoResoultionConstraint:

(NSString *)

constraint

Stores the provided video resolution media constraint string into the store.

If the provided constraint is no part of the available video resolutions the store operation will not be executed and NO will be returned.

Parameters

constraint

the string to be stored.

Returns

YES/NO depending on success.

storeVideoResoultionConstraint:() [2/2]

- (BOOL) storeVideoResoultionConstraint:

(NSString *)

constraint

Stores the provided video resolution media constraint string into the store.

If the provided constraint is no part of the available video resolutions the store operation will not be executed and NO will be returned.

Parameters

constraint

the string to be stored.

Returns

YES/NO depending on success.

Member Data Documentation

_settingsStore

- (ARDSettingsStore*) _settingsStore

protected

---

The documentation for this class was generated from the following files:

• DerivedData/WebKit/Build/Products/Debug/usr/local/include/webrtc/examples/objc/AppRTCMobile/ios/ARDSettingsModel.h
• Source/ThirdParty/libwebrtc/Source/webrtc/examples/objc/AppRTCMobile/ios/ARDSettingsModel.m