Inherits from NSObject
Declared in OTPublisherKit.h

Overview

Defines settings to be used when initializing a publisher using the [OTPublisherKit initWithDelegate:settings:] method.

Defining publisher settings

  name

The name of the publisher video. The [OTStream name] property for a stream published by this publisher will be set to this value (on all clients). The default value is nil.

@property (nonatomic, copy, nullable) NSString *name

Declared In

OTPublisherKit.h

  audioTrack

Whether to publish audio (YES, the default) or not (NO).

@property (nonatomic) BOOL audioTrack

Discussion

If this property is set to NO, the audio subsystem will not be initialized for the publisher, and setting the [OTPublisherKit publishAudio] property will have no effect. If your application does not require the use of audio, it is recommended to set this Builder property rather than use the [OTPublisherKit publishAudio] property, which only temporarily disables the audio track.

Declared In

OTPublisherKit.h

  videoTrack

Whether to publish video (YES, the default) or not (NO).

@property (nonatomic) BOOL videoTrack

Discussion

If this property is set to NO, the video subsystem will not be initialized for the publisher, and setting the [OTPublisherKit publishVideo] property will have no effect. If your application does not require the use of video, it is recommended to set this Builder property rather than use the [OTPublisherKit publishVideo] property, which only temporarily disables the video track.

Declared In

OTPublisherKit.h

  audioBitrate

The desired bitrate for the published audio, in bits per second. The supported range of values is 6,000 - 510,000. (Invalid values are ignored.) Set this value to enable high-quality audio (or to reduce bandwidth usage with lower-quality audio).

@property (nonatomic) int audioBitrate

Discussion

The following are recommended settings:

  • 8,000 - 12,000 for narrowband (NB) speech
  • 16,000 - 20,000 for wideband (WB) speech
  • 28,000 - 40,000 for full-band (FB) speech
  • 48,000 - 64,000 for full-band (FB) mono music
  • 64,000 - 128,000 for full-band (FB) stereo music

The default value is 40,000.

To set other audio settings, see the OTAudioDeviceManager interface.

Declared In

OTPublisherKit.h

  enableOpusDtx

Whether to enable Opus DTX (YES) or not (NO, the default). Enabling Opus DTX can reduce bandwidth usage in streams that have long periods of silence.

@property (nonatomic) BOOL enableOpusDtx

Declared In

OTPublisherKit.h

  scalableScreenshare

Whether to allow use of scalable video for a publisher that has the videoType set to OTStreamVideoTypeScreen (YES) or not (NO, the default).

@property (nonatomic) BOOL scalableScreenshare

Declared In

OTPublisherKit.h