blob: 9c8b5c5f62b6d1c4d145da5275e3002e5a44d02a [file] [log] [blame]
denicijad17d5362016-11-02 02:56:09 -07001/*
2 * Copyright 2016 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
11#import <Foundation/Foundation.h>
12
13NS_ASSUME_NONNULL_BEGIN
14/**
denicija2256e042016-11-09 06:26:18 -080015 * Model class for user defined settings.
denicijad17d5362016-11-02 02:56:09 -070016 *
denicija2256e042016-11-09 06:26:18 -080017 * Currently used for streaming media constraints and bitrate only.
denicijad17d5362016-11-02 02:56:09 -070018 * In future audio media constraints support can be added as well.
19 * Offers list of avaliable video resolutions that can construct streaming media constraint.
20 * Exposes methods for reading and storing media constraints from persistent store.
21 * Also translates current user defined media constraint into RTCMediaConstraints
22 * dictionary.
23 */
denicija2256e042016-11-09 06:26:18 -080024@interface ARDSettingsModel : NSObject
denicijad17d5362016-11-02 02:56:09 -070025
26/**
27 * Returns array of available capture resoultions.
28 *
29 * The capture resolutions are represented as strings in the following format
30 * [width]x[height]
31 */
32- (NSArray<NSString *> *)availableVideoResoultionsMediaConstraints;
33
34/**
35 * Returns current video resolution media constraint string.
36 * If no constraint is in store, default value of 640x480 is returned.
37 * When defaulting to value, the default is saved in store for consistency reasons.
38 */
39- (NSString *)currentVideoResoultionConstraintFromStore;
40
41/**
42 * Stores the provided video resolution media constraint string into the store.
43 *
44 * If the provided constraint is no part of the available video resolutions
45 * the store operation will not be executed and NO will be returned.
46 * @param constraint the string to be stored.
47 * @return YES/NO depending on success.
48 */
49- (BOOL)storeVideoResoultionConstraint:(NSString *)constraint;
50
51/**
52 * Converts the current media constraints from store into dictionary with RTCMediaConstraints
53 * values.
54 *
55 * @return NSDictionary with RTC width and height parameters
56 */
57- (nullable NSDictionary *)currentMediaConstraintFromStoreAsRTCDictionary;
denicijad17d5362016-11-02 02:56:09 -070058@end
59NS_ASSUME_NONNULL_END