Agora RTC Objective-C API Reference  Refactor
Instance Methods
<AgoraH265TranscoderProtocol> Protocol Reference

Inherits <NSObject>.

Instance Methods

(NSInteger) - enableTranscodeWithToken:channel:uid:
 
(NSInteger) - queryChannelWithToken:channel:uid:
 
(NSInteger) - triggerTranscodeWithToken:channel:uid:
 
(NSInteger) - registerTranscoderDelegate:
 
(NSInteger) - unregisterTranscoderDelegate:
 

Method Documentation

◆ enableTranscodeWithToken:channel:uid:

- (NSInteger) enableTranscodeWithToken: (NSString *_Nonnull)  token
channel: (NSString *_Nonnull)  channel
uid: (NSUInteger)  uid 

Enable transcoding for a channel.

Parameters
tokenThe token for authentication.
channelThe unique channel name for the AgoraRTC session in the string format.
uidUser ID.
Returns
  • 0: Success.
  • <0: Failure.

◆ queryChannelWithToken:channel:uid:

- (NSInteger) queryChannelWithToken: (NSString *_Nonnull)  token
channel: (NSString *_Nonnull)  channel
uid: (NSUInteger)  uid 

Query the transcoded channel of a channel.

Parameters
tokenThe token for authentication.
channelThe unique channel name for the AgoraRTC session in the string format.
uidUser ID.
Returns
  • 0: Success.
  • <0: Failure.

◆ triggerTranscodeWithToken:channel:uid:

- (NSInteger) triggerTranscodeWithToken: (NSString *_Nonnull)  token
channel: (NSString *_Nonnull)  channel
uid: (NSUInteger)  uid 

Trigger channel transcoding.

Parameters
tokenThe token for authentication.
channelThe unique channel name for the AgoraRTC session in the string format.
uidUser ID.
Returns
  • 0: Success.
  • <0: Failure.

◆ registerTranscoderDelegate:

- (NSInteger) registerTranscoderDelegate: (id< AgoraH265TranscoderDelegate >_Nullable)  delegate

Register a AgoraH265TranscoderDelegate object.

Parameters
delegateAgoraH265TranscoderDelegate.
Returns
  • 0: Success.
  • <0: Failure.

◆ unregisterTranscoderDelegate:

- (NSInteger) unregisterTranscoderDelegate: (id< AgoraH265TranscoderDelegate >_Nullable)  delegate

Unregister a AgoraH265TranscoderDelegate object.

Parameters
delegateAgoraH265TranscoderDelegate.
Returns
  • 0: Success.
  • <0: Failure.