Agora Objective-C API Reference for iOS/macOS

AgoraPublisherConfiguration Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

CDN live stream settings.

DEPRECATED

Agora recommends using setLiveTranscoding to set the CDN live stream settings.

  owner

Sets whether or not the current host is the RTMP stream owner.

@property (assign, nonatomic) BOOL owner

Discussion

  • YES: (Default) The current host is the RTMP stream owner and the push-stream configuration is enabled.
  • NO: The current host is not the RTMP stream owner and the push-stream configuration is disabled.

Declared In

AgoraObjects.h

  width

Width of the CDN live output data stream. The default value is 360.

@property (assign, nonatomic) NSInteger width

Declared In

AgoraObjects.h

  height

Height of the CDN live output data stream. The default value is 640.

@property (assign, nonatomic) NSInteger height

Declared In

AgoraObjects.h

  framerate

Frame rate of the CDN live output data stream. The default value is 15 fps.

@property (assign, nonatomic) NSInteger framerate

Declared In

AgoraObjects.h

  bitrate

Bitrate of the CDN live output data stream. The default value is 500 Kbps.

@property (assign, nonatomic) NSInteger bitrate

Declared In

AgoraObjects.h

  audiosamplerate

Audio sample rate of the CDN live output data stream. The default value is 48000.

@property (assign, nonatomic) NSInteger audiosamplerate

Declared In

AgoraObjects.h

  audiobitrate

Audio bitrate of the CDN live output data stream. The default value is 48.

@property (assign, nonatomic) NSInteger audiobitrate

Declared In

AgoraObjects.h

  audiochannels

Audio channels of the CDN live output data stream. The default value is 1.

@property (assign, nonatomic) NSInteger audiochannels

Declared In

AgoraObjects.h

  defaultLayout

  • 0: Tile horizontally.
  • 1: Layered windows.
  • 2: Tile vertically.
@property (assign, nonatomic) NSInteger defaultLayout

Declared In

AgoraObjects.h

  lifeCycle

CDN live video stream lifecycle: AgoraRtmpStreamLifeCycle.

@property (assign, nonatomic) AgoraRtmpStreamLifeCycle lifeCycle

Declared In

AgoraObjects.h

  injectStreamWidth

Width of the injected stream. Set it as 0.

@property (assign, nonatomic) NSInteger injectStreamWidth

Declared In

AgoraObjects.h

  injectStreamHeight

Height of the injected stream. Set it as 0.

@property (assign, nonatomic) NSInteger injectStreamHeight

Declared In

AgoraObjects.h

  injectStreamUrl

Address of the injected stream into the channel.

@property (copy, nonatomic) NSString *injectStreamUrl

Declared In

AgoraObjects.h

  publishUrl

The push-stream address for the picture-in-picture layouts. The default value is nil.

@property (copy, nonatomic) NSString *publishUrl

Declared In

AgoraObjects.h

  rawStreamUrl

The push-stream RTMP URL address of the original stream before transcoding. The default value is nil.

@property (copy, nonatomic) NSString *rawStreamUrl

Declared In

AgoraObjects.h

  extraInfo

Reserved field. The default value is nil.

@property (copy, nonatomic) NSString *extraInfo

Declared In

AgoraObjects.h

– validate

Whether or not the configuration is validated.

- (BOOL)validate

Declared In

AgoraObjects.h

X
Is this page helpful?