sdk/objc/api/peerconnection/RTCRtpCodecCapability.h

/*
 *  Copyright 2023 The WebRTC project authors. All Rights Reserved.
 *
 *  Use of this source code is governed by a BSD-style license
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
 *  in the file PATENTS.  All contributing project authors may
 *  be found in the AUTHORS file in the root of the source tree.
 */

#import <Foundation/Foundation.h>

#import "RTCMacros.h"

NS_ASSUME_NONNULL_BEGIN

typedef NS_ENUM(NSInteger, RTCRtpMediaType);

RTC_OBJC_EXPORT
@interface RTC_OBJC_TYPE (RTCRtpCodecCapability) : NSObject

/** Build MIME "type/subtype" string from name and kind. */
@property(nonatomic, readonly) NSString *mimeType;

/** Used to identify the codec. Equivalent to MIME subtype. */
@property(nonatomic, copy) NSString *name;

/** The media type of this codec. Equivalent to MIME top-level type. */
@property(nonatomic, assign) RTCRtpMediaType kind;

/** Clock rate in Hertz. If unset, the codec is applicable to any clock rate. */
@property(nonatomic, copy, nullable) NSNumber *clockRate;

/** Default payload type for this codec. Mainly needed for codecs that use
 *  that have statically assigned payload types.
 */
@property(nonatomic, copy, nullable) NSNumber *preferredPayloadType;

/** The number of audio channels supported. Unused for video codecs. */
@property(nonatomic, copy, nullable) NSNumber *numChannels;

/**Codec-specific parameters that must be signaled to the remote party.
 *
 * Corresponds to "a=fmtp" parameters in SDP.
 *
 * Contrary to ORTC, these parameters are named using all lowercase strings.
 * This helps make the mapping to SDP simpler, if an application is using SDP.
 * Boolean values are represented by the string "1".
 */
@property(nonatomic, copy) NSDictionary<NSString *, NSString *> *parameters;

@end

NS_ASSUME_NONNULL_END