Go

Server Gateway SDK API reference for Go.

OverviewCopy Anchor Link

• agoraservice package

  Method	Description
  Initialize	Initializes the agoraservice package.
  Release	Releases resources occupied by the agoraservice package.

• RtcConnection

  Method	Description
  NewRtcConnection	Creates an RTC connection object.
  Connect	Connects to the RTC channel.
  Disconnect	Disconnects from the RTC channel.
  RenewToken	Renews the token.
  RegisterObserver	Registers an RTC connection observer.
  UnregisterObserver	Destroys the RTC connection observer.
  CreateDataStream	Creates a data stream.
  SendStreamMessage	Sends a data stream message.
  GetAgoraParameter	Gets the AgoraParameter object.
  GetLocalUser	Gets the LocalUser object.
  Release	Releases the RTC connection.
  EnableEncryption	Enables encryption.

• RtcConnectionObserver

  Method	Description
  OnConnected	Occurs when the SDK connection state changes to 3.
  OnDisconnected	Occurs when the SDK connection state changes to 1.
  OnTokenPrivilegeWillExpire	Occurs when the token service will expire in 30 seconds.
  OnTokenPrivilegeDidExpire	Occurs when the token has expired.
  OnUserJoined	Occurs when a remote user joins the channel.
  OnUserLeft	Occurs when a remote user leaves the channel.
  OnStreamMessageError	Occurs when there is an error receiving a data stream message.
  OnError	Occurs when an error occurs.
  OnEncryptionError	Occurs when encryption errors occur.

• LocalUser

  Method	Description
  SetUserRole	Sets the user role.
  SetAudioEncoderConfiguration	Sets the audio encoder configuration.
  PublishAudio	Sends the local audio track to the channel.
  UnpublishAudio	Stops sending the local audio track to the channel.
  PublishVideo	Sends the local video track to the channel.
  UnpublishVideo	Stops sending the local video track to the channel.
  SubscribeAudio	Subscribes to the audio stream sent by a specific remote user in the channel.
  SubscribeAllAudio	Subscribes to all audio streams sent by remote users in the channel.
  UnsubscribeAudio	Stops subscribing to the audio stream sent by a specific remote user in the channel.
  UnsubscribeAllAudio	Stops subscribing to all audio streams sent by remote users in the channel.
  SetPlaybackAudioFrameBeforeMixingParameters	Sets the playback audio format.
  RegisterAudioFrameObserver	Registers an audio frame observer.
  UnregisterAudioFrameObserver	Destroys the AudioFrameObserver object.
  SubscribeVideo	Subscribes to the video stream sent by a specific remote user in the channel.
  SubscribeAllVideo	Subscribes to all video streams sent by remote users in the channel.
  UnsubscribeVideo	Stops subscribing to the video stream sent by a specific remote user in the channel.
  UnsubscribeAllVideo	Stops subscribing to all video streams sent by remote users in the channel.
  RegisterLocalUserObserver	Registers a local user observer.
  UnregisterLocalUserObserver	Destroys the local user observer.
  RegisterVideoFrameObserver	Registers a VideoFrameObserver object.
  UnregisterVideoFrameObserver	Destroys the VideoFrameObserver object.
  GetRtcConnection	Gets the RtcConnection object.
  SendAudioMetaData	Sends the audio metadata.

• LocalUserObserver

  Callback	Description
  OnUserAudioTrackStateChanged	Occurs when the state of a remote audio track changes.
  OnStreamMessage	Occurs when a data stream message is received.
  OnUserInfoUpdated	Occurs when user media information is updated.
  OnAudioMetaDataReceived	Occurs when the remote audio metadata is received.

• LocalAudioTrack

  Method	Description
  NewCustomAudioTrackPcm	Creates a custom PCM data track.
  NewCustomAudioTrackEncoded	Creates a custom encoded data track.
  SetEnabled	Enables or disables the local audio track.
  AdjustPublishVolume	Adjusts the audio publish volume.
  SetMaxBufferedAudioFrameNumber	Sets the maximum capacity of the audio send buffer.
  ClearSenderBuffer	Clears the current audio send buffer.
  SetSendDelayMs	Sets the minimum data duration allowed to be sent by the audio send buffer.
  Release	Releases the local audio track resources.

• LocalVideoTrack

  Method	Description
  NewCustomVideoTrackFrame	Creates a local video track object with a video source that sends YUV format video data.
  NewCustomVideoTrackEncoded	Creates a local video track object with a video source that sends encoded video data.
  SetEnabled	Enables or disables the local video track.
  SetVideoEncoderConfiguration	Sets the video encoder properties.

• MediaNodeFactory

  Method	Description
  NewMediaNodeFactory	Creates a media node factory object.
  Release	Releases the MediaNodeFactory object.

• AudioEncodedFrameSender

  Method	Description
  NewAudioEncodedFrameSender	Creates an encoded audio data sending module.
  SendEncodedAudioFrame	Sends an encoded audio frame to the local audio track.
  Release	Releases the AudioEncodedFrameSender object.

• AudioPcmDataSender

  Method	Description
  NewAudioPcmDataSender	Creates a PCM data sending module.
  SendAudioPcmData	Sends PCM format audio data to the local audio track.
  Release	Releases the AudioPcmDataSender object.

• AudioFrameObserver

  Callback	Description
  OnPlaybackAudioFrameBeforeMixing	Occurs when the audio data before mixing is received.

• VideoEncodedImageSender

  Method	Description
  NewVideoEncodedImageSender	Creates an encoded video data sending module.
  SendEncodedVideoImage	Sends an encoded video frame to the video track.

• VideoEncodedFrameObserver

  Callback	Description
  OnEncodedVideoFrame	Occurs when an encoded video frame is received.

• VideoFrameSender

  Method	Description
  NewVideoFrameSender	Creates a raw video data sending module.
  SendVideoFrame	Sends a YUV format video frame to the video track.

• VideoFrameObserver

  Callback	Description
  OnFrame	Occurs when a video frame is received.

agoraservice packageCopy Anchor Link

The agoraservice package serves as the entry point for the SDK, allowing you to create media tracks and establish connections.

InitializeCopy Anchor Link

Initialize the agoraservice package:

func Initialize(cfg *AgoraServiceConfig) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

ReleaseCopy Anchor Link

Release the resources occupied by the agoraservice package:

func Release() int

RtcConnectionCopy Anchor Link

The RtcConnection class is used to manage the connection between the SDK and the RTC channel. Once the connection is established, you can use the LocalUser object to send and receive media streams in the RTC channel. Connecting to the channel is an asynchronous operation, and you can monitor connection state changes and events through the RtcConnectionObserver object. RtcConnection can also monitor whether a remote user joins or leaves the channel.

NewRtcConnectionCopy Anchor Link

Creates an RTC connection object.

func NewRtcConnection(cfg *RtcConnectionConfig) *RtcConnection

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• RtcConnection object, if the method call succeeds.
• nil, if the method call fails.

ConnectCopy Anchor Link

Connects to the RTC channel.

func (conn *RtcConnection) Connect(token string, channel string, uid string) int

When the method succeeds, the connection state changes from true to 2.

Depending on whether the connection is successful, the connection state will change to 3 or 5. The SDK will trigger OnConnected or OnDisconnected to notify the connection state change.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -2: Invalid parameter.
  • -8: The current connection state is not true.

DisconnectCopy Anchor Link

Disconnects from the RTC channel. When the SDK disconnects from the channel, the connection state changes to true. You can also be notified through the OnDisconnected callback.

func (conn *RtcConnection) Disconnect() int

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

RenewTokenCopy Anchor Link

Renews the Token. The Token will expire after a certain period. When you receive the OnTokenPrivilegeWillExpire callback, you must generate a new token from your server and use this method to update the token. Otherwise, the SDK will disconnect from the channel.

func (conn *RtcConnection) RenewToken(token string) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

RegisterObserverCopy Anchor Link

Registers an RTC connection observer.

func (conn *RtcConnection) RegisterObserver(handler *RtcConnectionObserver) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

UnregisterObserverCopy Anchor Link

Unregisters the RTC connection observer.

func (conn *RtcConnection) UnregisterObserver() int

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

CreateDataStreamCopy Anchor Link

Creates a data stream.

func (conn *RtcConnection) CreateDataStream(reliable bool, ordered bool) (int, int)

Each user can create up to 5 data streams per channel.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• stream_id: The stream ID, if the method call succeeds.
• nil, if the method call fails.

SendStreamMessageCopy Anchor Link

Sends a data stream message.

func (conn *RtcConnection) SendStreamMessage(streamId int, msg []byte) int

This method sends a data stream message to all users in the channel. The SDK imposes the following restrictions on this method:

• A maximum of 30 packets can be sent per second within the channel, with each packet being up to 1 KB in size.
• Each client can send up to 6 KB of data per second.
• Each user in the channel can have up to 5 data channels simultaneously.

Upon successfully calling this method, the remote end will trigger the OnStreamMessage callback, where the remote user can receive the stream message.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

GetAgoraParameterCopy Anchor Link

Get AgoraParameter object.

func (conn *RtcConnection) GetAgoraParameter() *AgoraParameter

ReturnsCopy Anchor Link

• AgoraParameter object, if the method call was succeeds.
• nil, if the method call fails.

GetLocalUserCopy Anchor Link

Get LocalUser Object. Each connection corresponds to only one local user.

func (conn *RtcConnection) GetLocalUser() *LocalUser

ReturnsCopy Anchor Link

• LocalUser object, if the method call succeeds.
• nil, if the method call fails.

ReleaseCopy Anchor Link

Releases the RTC connection.

func (conn *RtcConnection) Release()

EnableEncryptionCopy Anchor Link

func (conn *RtcConnection) EnableEncryption(enable int, config *EncryptionConfig) int

Enables encryption.

This method needs to be called before Connect. You need to set the encryption mode and encryption configuration in this method.

ParametersCopy Anchor Link

enable

Whether to enable encryption functionality.

• 1: Enable
• 0: Disable

config

The encryption configuration: EncryptionConfig.

Return ValuesCopy Anchor Link

• 0: Success.
• < 0: Failure.

RtcConnectionObserverCopy Anchor Link

The RtcConnectionObserver class is used to monitor the SDK connection state.

OnConnectedCopy Anchor Link

Triggered when the SDK's connection state to the channel changes to 3.

OnConnected func(con *RtcConnection, conInfo *RtcConnectionInfo, reason int)

ParametersCopy Anchor Link

con

The RTC connection object. See RtcConnection for details.

conInfo

Connection information. See RtcConnectionInfo for details.

reason

Connection state change reason:

• 0: Establishing a network connection.

• 1: Successfully joined the channel.

• 2: Network connection interrupted.

• 3: Network connection forbidden by the server.

• 4: Failed to join the channel.

• 5: Left the channel.

• 6: Invalid App ID. Please change to a valid App ID and try again.

• 7: Invalid channel name. Please change to a valid channel name and try again.

• 8: The generated token is invalid. Generally, the following reasons:

  • App Certificate is enabled on the console, but the Token is not used when joining the channel. When App Certificate is enabled, you must use a Token.
  • The uid specified in connect when joining the channel does not match the uid used when generating the Token.

• 9: The generated Token is invalid.

• 10: This user is banned by the server.

• 11: SDK attempts to reconnect due to setting a proxy server.

• 12: The network connection state changes due to updating the Token.

• 13: The client IP address changes, possibly due to changes in network type or the IP or port of the network operator.

• 14: SDK connection to the server times out, enters the automatic reconnection state.

• 15: Rejoined the channel successfully.

• 16: SDK and the server lose connection.

• 17: The connection state changes due to the echo test.

• 18: The user changed the local IP address.

OnDisconnectedCopy Anchor Link

Triggered when the SDK's connection state to the channel changes to 1.

OnDisconnected func(con *RtcConnection, conInfo *RtcConnectionInfo, reason int)

ParametersCopy Anchor Link

con

RTC connection object. See RtcConnection for details.

conInfo

Connection information. See RtcConnectionInfo for details.

reason

Connection state change reason:

• 0: Establishing a network connection.

• 1: Successfully joined the channel.

• 2: Network connection interrupted.

• 3: Network connection forbidden by the server.

• 4: Failed to join the channel.

• 5: Left the channel.

• 6: Invalid App ID. Please change to a valid App ID and try again.

• 7: Invalid channel name. Please change to a valid channel name and try again.

• 8: The generated token is invalid. Generally, the following reasons:

  • App Certificate is enabled on the console, but the Token is not used when joining the channel. When App Certificate is enabled, you must use a Token.
  • The uid specified in connect when joining the channel does not match the uid used when generating the Token.

• 9: The generated Token is invalid.

• 10: This user is banned by the server.

• 11: SDK attempts to reconnect due to setting a proxy server.

• 12: The network connection state changes due to updating the Token.

• 13: The client IP address changes, possibly due to changes in network type or the IP or port of the network operator.

• 14: SDK connection to the server times out, enters the automatic reconnection state.

• 15: Rejoined the channel successfully.

• 16: SDK and the server lose connection.

• 17: The connection state changes due to the echo test.

• 18: The user changed the local IP address.

OnTokenPrivilegeWillExpireCopy Anchor Link

Triggered when the token is about to expire within 30 seconds.

OnTokenPrivilegeWillExpire func(con *RtcConnection, token string)

During a call, if the token is about to expire, the SDK will trigger this callback 30 seconds in advance to remind the app to update the token.

Upon receiving this callback, you need to generate a new token on your server and then call RenewToken to pass the newly generated token to the SDK.

ParametersCopy Anchor Link

OnTokenPrivilegeDidExpireCopy Anchor Link

Triggered when the token has expired.

OnTokenPrivilegeDidExpire func(con *RtcConnection)

During a call, if the token has expired, the SDK will trigger this callback to remind the app to update the token.

Upon receiving this callback, you need to generate a new token on your server and then call Connect to reconnect to the channel.

ParametersCopy Anchor Link

OnUserJoinedCopy Anchor Link

Triggered when a remote user joins the channel. You can use this callback to get the ID of the remote user.

OnUserJoined func(con *RtcConnection, uid string)

ParametersCopy Anchor Link

OnUserLeftCopy Anchor Link

Triggered when a remote user leaves the channel. You can use the reason parameter to get the reason why the user left the channel.

OnUserLeft func(con *RtcConnection, uid string, reason int)

ParametersCopy Anchor Link

con

RTC connection object. See RtcConnection for details.

uid

User ID of the remote user.

reason

Connection state change reason:

• 0: Establishing a network connection.

• 1: Successfully joined the channel.

• 2: Network connection interrupted.

• 3: Network connection forbidden by the server.

• 4: Failed to join the channel.

• 5: Left the channel.

• 6: Invalid App ID. Please change to a valid App ID and try again.

• 7: Invalid channel name. Please change to a valid channel name and try again.

• 8: The generated token is invalid. Generally, the following reasons:

  • App Certificate is enabled on the console, but the Token is not used when joining the channel. When App Certificate is enabled, you must use a Token.
  • The uid specified in connect when joining the channel does not match the uid used when generating the Token.

• 9: The generated Token is invalid.

• 10: This user is banned by the server.

• 11: SDK attempts to reconnect due to setting a proxy server.

• 12: The network connection state changes due to updating the Token.

• 13: The client IP address changes, possibly due to changes in network type or the IP or port of the network operator.

• 14: SDK connection to the server times out, enters the automatic reconnection state.

• 15: Rejoined the channel successfully.

• 16: SDK and the server lose connection.

• 17: The connection state changes due to the echo test.

• 18: The user changed the local IP address.

OnStreamMessageErrorCopy Anchor Link

Triggered when an error occurs in receiving stream messages. This callback indicates that the local user did not receive the stream message sent by the remote user using the send_stream_message method.

OnStreamMessageError func(con *RtcConnection, uid string, streamId int, errCode int, missed int, cached int)

ParametersCopy Anchor Link

OnErrorCopy Anchor Link

Triggered when an error occurs. This callback method indicates that a network or media-related error occurred while the SDK was running. Generally, errors reported by the SDK mean that the SDK cannot automatically recover and requires intervention from the app or user notification.

OnError func(con *RtcConnection, err int, msg string)

ParametersCopy Anchor Link

OnEncryptionErrorCopy Anchor Link

OnEncryptionError func(con *RtcConnection, err int)

Occurs when encryption errors occur.

ParametersCopy Anchor Link

LocalUserCopy Anchor Link

The LocalUser class defines the behavior and state of the local user. Each RTC connection has its own user. You can get the local user through GetLocalUser. Each user has two roles: broadcaster (can send and receive audio and video streams) and audience (can only receive audio and video streams).

SetUserRoleCopy Anchor Link

Sets the user role. You can call this method before or after the user connects to the channel.

func (localUser *LocalUser) SetUserRole(role int) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

SetAudioEncoderConfigurationCopy Anchor Link

Sets audio encoding. The SDK will apply the configuration to all sent audio tracks.

func (localUser *LocalUser) SetAudioEncoderConfiguration(config *AudioEncoderConfiguration) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

PublishAudioCopy Anchor Link

Sends the local audio track to the channel. By default, all published audio tracks are mixed.

func (localUser *LocalUser) PublishAudio(track *LocalAudioTrack) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -5: Returned if the local user's role is not a broadcaster.

UnpublishAudioCopy Anchor Link

Stops sending the local audio track to the channel.

func (localUser *LocalUser) UnpublishAudio(track *LocalAudioTrack) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

PublishVideoCopy Anchor Link

Sends the local video track to the channel.

func (localUser *LocalUser) PublishVideo(track *LocalVideoTrack) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

UnpublishVideoCopy Anchor Link

Stops sending the local video track to the channel.

func (localUser *LocalUser) UnpublishVideo(track *LocalVideoTrack) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

SubscribeAudioCopy Anchor Link

Subscribes to the audio stream sent by a specific remote user in the channel.

func (localUser *LocalUser) SubscribeAudio(uid string) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -2: Error returned if the user does not exist or the uid is invalid.

SubscribeAllAudioCopy Anchor Link

Subscribes to the audio streams sent by all remote users in the channel. This method will automatically subscribe to the audio streams of users who join the channel later.

func (localUser *LocalUser) SubscribeAllAudio() int

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

UnsubscribeAudioCopy Anchor Link

Stops subscribing to the audio stream sent by a specific remote user in the channel.

func (localUser *LocalUser) UnsubscribeAudio(uid string) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -2: Error returned if the user does not exist or the uid is invalid.

UnsubscribeAllAudioCopy Anchor Link

Stops subscribing to the audio streams sent by all remote users in the channel. This method will automatically unsubscribe from the audio streams of users who join the channel later. You must call SubscribeAudio or SubscribeAllAudio to resume subscribing to audio.

func (localUser *LocalUser) UnsubscribeAllAudio() int

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

SetPlaybackAudioFrameBeforeMixingParametersCopy Anchor Link

Sets the playback audio format. This method sets the format of the data for the OnPlaybackAudioFrameBeforeMixing callback.

func (localUser *LocalUser) SetPlaybackAudioFrameBeforeMixingParameters(channels int, sampleRate int) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

RegisterAudioFrameObserverCopy Anchor Link

Registers the audio frame observer. You must implement the AudioFrameObserver class and register the callbacks as needed.

func (localUser *LocalUser) RegisterAudioFrameObserver(observer *AudioFrameObserver, enableVad int, vadConfigure *AudioVadConfigV2) int

ParametersCopy Anchor Link

observer

An instance of the AudioFrameObserver class.

enableVad

Whether to enable the built-in voice activity detection (VAD):

• 0: Disable VAD.
• 1: Enable VAD. The SDK returns the VAD results in the OnPlaybackAudioFrameBeforeMixing callback.

vadConfigure

The VAD configuration, an AudioVadConfigV2 object. The SDK uses this parameter only when enableVad is 1.

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

UnregisterAudioFrameObserverCopy Anchor Link

Destroys the AudioFrameObserver object.

func (localUser *LocalUser) UnregisterAudioFrameObserver() int

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

SubscribeVideoCopy Anchor Link

Subscribes to the video stream sent by a specified remote user in the channel.

func (localUser *LocalUser) SubscribeVideo(uid string, options *VideoSubscriptionOptions) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -2: Error returned if the user does not exist or the uid is invalid.

SubscribeAllVideoCopy Anchor Link

Subscribes to the video streams sent by all remote users in the channel. This method automatically subscribes to the video streams of users who join the channel later.

func (localUser *LocalUser) SubscribeAllVideo(options *VideoSubscriptionOptions) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

UnsubscribeVideoCopy Anchor Link

Stops subscribing to the video stream sent by a specified remote user in the channel.

func (localUser *LocalUser) UnsubscribeVideo(uid string) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -2: Error returned if the user does not exist or the uid is invalid.

UnsubscribeAllVideoCopy Anchor Link

Stops subscribing to the video streams sent by all remote users in the channel. This method automatically unsubscribes from the video streams of users who join the channel later. You must call SubscribeVideo or SubscribeAllVideo to resume the subscription.

func (localUser *LocalUser) UnsubscribeAllVideo() int

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

RegisterLocalUserObserverCopy Anchor Link

Registers a local user observer.

func (localUser *LocalUser) RegisterLocalUserObserver(observer *LocalUserObserver) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

UnregisterLocalUserObserverCopy Anchor Link

Destroys the local user observer.

func (localUser *LocalUser) UnregisterLocalUserObserver() int

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

RegisterVideoFrameObserverCopy Anchor Link

Registers a VideoFrameObserver object.

func (localUser *LocalUser) RegisterVideoFrameObserver(observer *VideoFrameObserver) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

UnregisterVideoFrameObserverCopy Anchor Link

Destroys the VideoFrameObserver object.

func (localUser *LocalUser) UnregisterVideoFrameObserver() int

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

GetRtcConnectionCopy Anchor Link

Gets the RtcConnection object.

func (localUser *LocalUser) GetRtcConnection() *RtcConnection

ReturnsCopy Anchor Link

• RtcConnection object, if the method call succeeds.
• nil, if the method call fails.

SendAudioMetaDataCopy Anchor Link

func (localUser *LocalUser) SendAudioMetaData(metaData []byte) int

Sends the audio metadata.

A successful call triggers the OnAudioMetaDataReceived callback on the remote end. The remote user can get the audio metadata in this callback.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

LocalUserObserverCopy Anchor Link

The LocalUserObserver class.

OnUserAudioTrackStateChangedCopy Anchor Link

Triggered when the state of a remote audio track changes.

OnUserAudioTrackStateChanged func(localUser *LocalUser, uid string, remoteAudioTrack *RemoteAudioTrack, state int, reason int, elapsed int)

ParametersCopy Anchor Link

OnStreamMessageCopy Anchor Link

Callback for receiving stream messages. This callback indicates that the local user has received a stream message sent by a remote user using the SendStreamMessage method.

OnStreamMessage func(localUser *LocalUser, uid string, streamId int, data []byte)

ParametersCopy Anchor Link

OnUserInfoUpdatedCopy Anchor Link

Triggered when user media information is updated.

OnUserInfoUpdated func(localUser *LocalUser, uid string, userMediaInfo int, val int)

ParametersCopy Anchor Link

OnAudioMetaDataReceivedCopy Anchor Link

OnAudioMetaDataReceived func(localUser *LocalUser, uid string, metaData []byte)

Occurs when the remote audio metadata is received.

This callback indicates that the local user has received the audio metadata sent by the remote user using the SendAudioMetaData method.

ParametersCopy Anchor Link

LocalAudioTrackCopy Anchor Link

The LocalAudioTrack class is the base class for local audio tracks.

NewCustomAudioTrackPcmCopy Anchor Link

Creates a custom PCM data track.

func NewCustomAudioTrackPcm(pcmSender *AudioPcmDataSender) *LocalAudioTrack

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• LocalAudioTrack object, if the method call succeeds.
• nil, if the method call fails.

NewCustomAudioTrackEncodedCopy Anchor Link

Creates a custom encoded data track.

func NewCustomAudioTrackEncoded(encodedAudioSender *AudioEncodedFrameSender, mixMode AudioTrackMixingState) *LocalAudioTrack

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• LocalAudioTrack object, if the method call succeeds.
• nil, if the method call fails.

SetEnabledCopy Anchor Link

Enables or disables the local audio track. Once enabled, the SDK can capture, process, and encode local audio.

func (track *LocalAudioTrack) SetEnabled(enable bool)

ParametersCopy Anchor Link

AdjustPublishVolumeCopy Anchor Link

Adjusts the audio publish volume.

func (track *LocalAudioTrack) AdjustPublishVolume(volume int) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

SetMaxBufferedAudioFrameNumberCopy Anchor Link

Sets the maximum capacity of the audio send buffer.

func (track *LocalAudioTrack) SetMaxBufferedAudioFrameNumber(frameNum int)

In applications like AI interaction, the frequency of sending audio frames from the sender may be irregular. For example, sometimes 1 frame is sent every 20 ms, and sometimes 3 frames are sent every 20 ms. If the SDK sends data to the Agora server based on the actual sending frequency, the receiver may experience stuttering or frame drops. To optimize audio transmission performance, the SDK sets an audio send buffer. Regardless of the actual frequency of sending audio frames, the SDK stores the data in the audio send buffer. Once the data in the audio send buffer reaches the minimum duration allowed to be sent, the SDK starts sending data to the receiver at a rate of 10 ms per frame.

The default maximum capacity of the audio send buffer in the SDK is 6000 frames, which means it can store up to 6000 frames of data, or 60 seconds of data. If you need a larger buffer capacity, you can call this method to adjust it. If you also need to set the minimum duration of data allowed to be sent in the audio send buffer, call the SetSendDelayMs method.

ParametersCopy Anchor Link

ClearSenderBufferCopy Anchor Link

Clears the current audio send buffer.

func (track *LocalAudioTrack) ClearSenderBuffer() int

If you no longer need the data in the current audio send buffer, you can call this method to clear the buffer. For example, if a user asks an AI a question and the AI is transmitting audio to the user through the SDK, the SDK's audio send buffer continuously has data in and out. When the user interrupts the AI's response and asks another question, you can call this method to let the SDK clear the current unsent buffered data to quickly buffer the AI's response to the new topic.

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

SetSendDelayMsCopy Anchor Link

Sets the minimum duration of data allowed to be sent in the audio send buffer.

func (track *LocalAudioTrack) SetSendDelayMs(delayMs int) int

The SDK's default minimum duration of data allowed to be sent is 160 ms. This means the SDK will wait until the audio send buffer is filled with 160 ms of data before sending it to the receiver, which has the following effects:

• If the sender sends data greater than or equal to 160 ms at a time, such as 800 ms, the SDK will immediately start sending data to the receiver at a rate of 10 ms per frame.
• If the sender sends data less than 160 ms at a time, such as 100 ms, the SDK will wait until the buffer has 160 ms of data before sending it to the receiver at a rate of 10 ms per frame. This can cause a delay of up to 60 ms.

You can adjust the minimum duration of data allowed to be sent in the buffer according to your actual business needs by calling this method.

ParametersCopy Anchor Link

ReleaseCopy Anchor Link

Releases the local audio track resources.

func (track *LocalAudioTrack) Release()

LocalVideoTrackCopy Anchor Link

The LocalVideoTrack class provides basic methods for local video tracks. You can publish one or more video tracks using the PublishVideo method.

NewCustomVideoTrackFrameCopy Anchor Link

Creates a local video track object with a video source that sends YUV format video data. This track object can be used to send YUV format video data.

func NewCustomVideoTrackFrame(videoSender *VideoFrameSender) *LocalVideoTrack

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• LocalVideoTrack object: If the method call succeeds.
• nil: If the method call fails.

NewCustomVideoTrackEncodedCopy Anchor Link

Creates a local video track object with a video source that sends encoded video data. This track object can be used to send encoded video data, such as H.264 or VP8 format encoded data.

func NewCustomVideoTrackEncoded(videoSender *VideoEncodedImageSender, senderOptions *VideoEncodedImageSenderOptions) *LocalVideoTrack

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• LocalVideoTrack object: If the method call succeeds.
• nil: If the method call fails.

SetEnabledCopy Anchor Link

Enables or disables the local video track. After the local video track is enabled, the SDK can capture, process, and encode local video.

func (track *LocalVideoTrack) SetEnabled(enable bool)

ParametersCopy Anchor Link

SetVideoEncoderConfigurationCopy Anchor Link

Sets the video encoding properties.

func (track *LocalVideoTrack) SetVideoEncoderConfiguration(cfg *VideoEncoderConfiguration) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: If the method call succeeds.
• < 0: If the method call fails.

MediaNodeFactoryCopy Anchor Link

The MediaNodeFactory class.

NewMediaNodeFactoryCopy Anchor Link

Creates a media node factory object.

func NewMediaNodeFactory() *MediaNodeFactory

ReturnsCopy Anchor Link

• MediaNodeFactory object, if the method call succeeds.
• nil, if the method call fails.

ReleaseCopy Anchor Link

Releases the MediaNodeFactory object.

func (factory *MediaNodeFactory) Release()

AudioEncodedFrameSenderCopy Anchor Link

The AudioEncodedFrameSender class.

NewAudioEncodedFrameSenderCopy Anchor Link

Creates an encoded audio data sending module. This method creates an AudioEncodedFrameSender object, which can be used in the NewCustomAudioTrackEncoded method.

func (mediaNodeFactory *MediaNodeFactory) NewAudioEncodedFrameSender() *AudioEncodedFrameSender

ReturnsCopy Anchor Link

• AudioEncodedFrameSender object, if the method call succeeds.
• nil, if the method call fails.

SendEncodedAudioFrameCopy Anchor Link

Sends the encoded audio frame to the local audio track.

func (sender *AudioEncodedFrameSender) SendEncodedAudioFrame(payload []byte, frameInfo *EncodedAudioFrameInfo) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

ReleaseCopy Anchor Link

Releases the AudioEncodedFrameSender object.

func (sender *AudioEncodedFrameSender) Release()

AudioPcmDataSenderCopy Anchor Link

The AudioPcmDataSender class.

NewAudioPcmDataSenderCopy Anchor Link

Creates a PCM data sender module. This method creates an AudioPcmDataSender object, which can be used in the NewCustomAudioTrackPcm method.

func (mediaNodeFactory *MediaNodeFactory) NewAudioPcmDataSender() *AudioPcmDataSender

ReturnsCopy Anchor Link

• AudioPcmDataSender object, if the method call succeeds.
• nil, if the method call fails.

SendAudioPcmDataCopy Anchor Link

Sends PCM format audio data to the local audio track.

func (sender *AudioPcmDataSender) SendAudioPcmData(frame *AudioFrame) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

ReleaseCopy Anchor Link

Releases the AudioPcmDataSender object.

func (sender *AudioPcmDataSender) Release()

AudioFrameObserverCopy Anchor Link

The AudioFrameObserver class.

OnPlaybackAudioFrameBeforeMixingCopy Anchor Link

Obtains the audio data before mixing for playback.

OnPlaybackAudioFrameBeforeMixing func(localUser *LocalUser, channelId string, uid string, frame *AudioFrame, vadResultStat VadState, vadResultFrame *AudioFrame) bool

ParametersCopy Anchor Link

localUser

LocalUser class.

channelId

Channel name.

uid

User ID of the remote user.

frame

Raw audio data. See AudioFrame for details.

vadResultStat

The VAD state. Valid only when you enable VAD in RegisterAudioFrameObserver:

• -1 (VadStateInvalid): VAD is not enabled.
• 0 (VadStateNoSpeeking): Not speaking.
• 1 (VadStateStartSpeeking): Started speaking.
• 2 (VadStateSpeeking): Speaking.
• 3 (VadStateStopSpeeking): Stopped speaking.

vadResultFrame

The audio data processed by VAD. When VAD is enabled, use this data instead of frame for downstream processing, such as speech recognition.

ReturnsCopy Anchor Link

• true: The audio frame data is valid and will be sent.
• false: The audio frame data is invalid and will be discarded.

VideoEncodedImageSenderCopy Anchor Link

The VideoEncodedImageSender class.

NewVideoEncodedImageSenderCopy Anchor Link

Creates a video encoded data sender module. This method creates a VideoEncodedImageSender object, which can be used in the NewCustomVideoTrackEncoded method.

func (mediaNodeFactory *MediaNodeFactory) NewVideoEncodedImageSender() *VideoEncodedImageSender

ReturnsCopy Anchor Link

• VideoEncodedImageSender object, if the method call succeeds.
• nil, if the method call fails.

SendEncodedVideoImageCopy Anchor Link

Sends an encoded video frame to the video track.

func (sender *VideoEncodedImageSender) SendEncodedVideoImage(payload []byte, frameInfo *EncodedVideoFrameInfo) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

VideoEncodedFrameObserverCopy Anchor Link

The VideoEncodedFrameObserver class.

OnEncodedVideoFrameCopy Anchor Link

Occurs when an encoded video frame is received.

OnEncodedVideoFrame func(uid string, imageBuffer []byte, frameInfo *EncodedVideoFrameInfo) bool

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Whether to accept the encoded video frame:

• true: Accept.
• false: Do not accept.

VideoFrameSenderCopy Anchor Link

The VideoFrameSender class.

NewVideoFrameSenderCopy Anchor Link

Creates a raw video data sender module. This method creates a VideoFrameSender object, which can be used in the NewCustomVideoTrackFrame method.

func (mediaNodeFactory *MediaNodeFactory) NewVideoFrameSender() *VideoFrameSender

ReturnsCopy Anchor Link

• VideoFrameSender object, if the method call succeeds.
• nil, if the method call fails.

SendVideoFrameCopy Anchor Link

Sends a YUV format video frame to the video track.

func (sender *VideoFrameSender) SendVideoFrame(frame *ExternalVideoFrame) int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

VideoFrameObserverCopy Anchor Link

The VideoFrameObserver class.

OnFrameCopy Anchor Link

Triggered when a video frame is received.

OnFrame func(channelId string, userId string, frame *VideoFrame) bool

ParametersCopy Anchor Link

Data typeCopy Anchor Link

ClassesCopy Anchor Link

AgoraServiceConfigCopy Anchor Link

Global configuration for the AgoraServiceConfig class, set when calling the Initialize method.

type AgoraServiceConfig struct {
    EnableAudioProcessor bool
    EnableAudioDevice    bool
    EnableVideo          bool
    AppId                string
    AreaCode             AreaCode
    ChannelProfile       ChannelProfile
    AudioScenario        AudioScenario
    UseStringUid         bool
    LogPath              string
    LogSize              int
    DomainLimit          int
    ShouldCallbackWhenMuted int
    EnableSteroEncodeMode   int
}

EnableAudioProcessor

Whether to enable the audio processing module. - true: (Default) Enable the audio processing module. - false: Disable the audio processing module. You will not be able to create audio tracks.

EnableAudioDevice

Whether to enable the Audio Device Module (ADM). ADM is used to manage audio devices, such as recording and playing audio. - true: (Default) Enable the audio device module. You can record and play audio. - false: Disable the audio device module. You cannot record or play audio. Note: If you set EnableAudioDevice to false and EnableAudioProcessor to true, you will not be able to use audio devices, but you can push PCM audio data.

EnableVideo

Whether to enable video. - true: Enable video. - false: (Default) Disable video.

AppId

Your Agora project App ID. If your Agora project has token authentication enabled, you can also set this parameter to the RTC Token. See Get App ID for details.

AreaCode

Server access area. This feature is an advanced setting and is applicable to use-cases with access security restrictions. Area codes support bitwise operations. After specifying the access area, the SDK connects to the Agora servers within the specified area. See AreaCode for details.

ChannelProfile

Channel use-case. See ChannelProfile for details.

AudioScenario

Audio encoding properties. See AudioScenario for details.

UseStringUid

Whether to use String user ID. - true: Use. - false: Do not use.

LogPath

Log file path.

LogSize

Log file size (in bytes).

DomainLimit

Whether to enable domain limit:

• 1: Yes. Only connects to domains that are parsed by DNS
• 0: (Default) No. There is no limit when connecting to domains

ShouldCallbackWhenMuted

Whether the SDK still triggers the OnPlaybackAudioFrameBeforeMixing callback after a remote user mutes their audio:

• 0: (Default) No. The SDK stops triggering the callback when the remote user mutes their audio.
• Greater than 0: Yes. The SDK keeps triggering the callback when the remote user mutes their audio.

EnableSteroEncodeMode

Whether to enable stereo encoding mode:

• 0: (Default) No.
• Greater than 0: Yes. Each connection uses the AudioScenarioGameStreaming audio scenario and the AudioProfileMusicHighQualityStereo audio profile, with echo cancellation, noise suppression, and automatic gain control disabled. The encoding bitrate is 32 Kbps.

AudioEncoderConfigurationCopy Anchor Link

Audio encoding settings.

type AudioEncoderConfiguration struct {
    AudioProfile int
}

AudioFrameCopy Anchor Link

PCM audio data.

type AudioFrame struct {
    Type              AudioFrameType
    SamplesPerChannel int
    BytesPerSample    int
    Channels          int
    SamplesPerSec     int
    Buffer            []byte
    RenderTimeMs      int64
    AvsyncType        int
    FarFieldFlag      int
    Rms               int
    VoiceProb         int
    MusicProb         int
    Pitch             int
}

EncodedAudioFrameInfoCopy Anchor Link

Encoded audio data.

type EncodedAudioFrameInfo struct {
    Speech bool
    Codec AudioCodecType
    SampleRateHz int
    SamplesPerChannel int
    SendEvenIfEmpty bool
    NumberOfChannels int
}

EncodedVideoFrameInfoCopy Anchor Link

Encoded video data.

type EncodedVideoFrameInfo struct {
    CodecType        VideoCodecType
    Width            int
    Height           int
    FramesPerSecond  int
    FrameType        VideoFrameType
    Rotation         VideoOrientation
    TrackId          int
    CaptureTimeMs    int64
    DecodeTimeMs     int64
    Uid              uint32
    StreamType       int
}

EncryptionConfigCopy Anchor Link

type EncryptionConfig struct {
	EncryptionMode int
	EncryptionKey string
	EncryptionKdfSalt []byte
}

EncryptionMode

Encryption mode:

• 1: 128-bit AES encryption, XTS mode.
• 2: 128-bit AES encryption, ECB mode.
• 3: 256-bit AES encryption, XTS mode.
• 4: 128-bit SM4 encryption, ECB mode.
• 5: 128-bit AES encryption, GCM mode.
• 6: 256-bit AES encryption, GCM mode.
• 7: (Default) 128-bit AES encryption, GCM mode. This encryption mode requires setting a salt (EncryptionKdfSalt).
• 8: 256-bit AES encryption, GCM mode. This encryption mode requires setting a salt (EncryptionKdfSalt).

EncryptionKey

Encryption key, string type, with no length limit. It is recommended to use a 32-byte key.

encryptionKdfSalt

Encryption salt, 32 bytes in length. It is recommended to generate the salt using OpenSSL on the server side.

ExternalVideoFrameCopy Anchor Link

YUV format video data.

type ExternalVideoFrame struct {
    Type           VideoBufferType
    Format         VideoPixelFormat
    Buffer         []byte
    Stride         int
    Height         int
    CropLeft       int
    CropTop        int
    CropRight      int
    CropBottom     int
    Rotation       VideoOrientation
    Timestamp      int64
    EGLContext     unsafe.Pointer
    EGLType        int
    TextureID      int
    Matrix         [16]float32
    MetadataBuffer []byte
    AlphaBuffer    []byte
    FillAlphaBuffer bool
    AlphaMode      int
    ColorSpace     ColorSpaceType;
}

Type

Type of video data. See VideoBufferType.

Format

Pixel format. See VideoPixelFormat.

Buffer

Video buffer.

Stride

Stride of the incoming video frame, in pixels, not bytes. For Texture, this value indicates the width of the Texture.

Height

Height of the incoming video frame.

CropLeft

Field related to raw data. Specifies the number of pixels to crop from the left. Default is 0. This parameter is only applicable to raw video data.

CropTop

Field related to raw data. Specifies the number of pixels to crop from the top. Default is 0. This parameter is only applicable to raw video data.

CropRight

Field related to raw data. Specifies the number of pixels to crop from the right. Default is 0. This parameter is only applicable to raw video data.

CropBottom

Field related to raw data. Specifies the number of pixels to crop from the bottom. Default is 0. This parameter is only applicable to raw video data.

Rotation

Field related to raw data. Specifies whether to rotate the incoming video clockwise. Default is 0. See VideoOrientation.

Timestamp

Timestamp of the incoming video frame in milliseconds. Incorrect timestamps can cause frame drops or audio-video desynchronization.

EGLContext

This parameter is only applicable to video data in Texture format. - When using the Khronos-defined OpenGL interface (javax.microedition.khronos.egl.), set the eglContext to this field. - When using the Android-defined OpenGL interface (android.opengl.), set the eglContext to this field.

EGLType

This parameter is only applicable to video data in Texture format. Specifies the EGL context type.

TextureID

This parameter is only applicable to video data in Texture format. Specifies the Texture ID of the video frame.

Matrix

This parameter is only applicable to video data in Texture format. It is an input 4x4 transformation matrix, typically an identity matrix.

MetadataBuffer

The metadata buffer of the video frame. The default value is nil.

AlphaBuffer

Alpha channel data output by the portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait). By setting this parameter, you can render the video background with various effects, such as transparency, solid color, image, or video.

FillAlphaBuffer

[For BGRA or RGBA only] Whether to extract alphaBuffer from BGRA or RGBA data.

• true: Yes. Set it to true if you do not explicitly specify the alphaBuffer.
• false: (Default) No.

AlphaMode

The relative position between alphaBuffer and the frame.

• 0: (Default) Normal frame.
• 1: alphaBuffer is above the frame.
• 2: alphaBuffer is below the frame.
• 3: alphaBuffer is on the left of the frame.
• 4: alphaBuffer is on the right of the frame.

ColorSpace

The color space of the video frame. See ColorSpaceType.

RtcConnectionConfigCopy Anchor Link

RTC connection configuration.

type RtcConnectionConfig struct {
    AutoSubscribeAudio bool
    AutoSubscribeVideo bool
    EnableAudioRecordingOrPlayout bool
    MaxSendBitrate int
    MinPort int
    MaxPort int
    ClientRole     ClientRole
    ChannelProfile ChannelProfile
    AudioRecvMediaPacket bool
    VideoRecvMediaPacket bool
}

RtcConnectionInfoCopy Anchor Link

RTC connection information.

type RtcConnectionInfo struct {
    ConnectionId uint
    ChannelId string
    State int
    LocalUserId string
    InternalUid uint
}

VideoEncodedImageSenderOptionsCopy Anchor Link

Configuration for the local video track object containing the video source that sends encoded video data.

type VideoEncodedImageSenderOptions struct {
    CcMode         VideoSendCcState
    CodecType      VideoCodecType
    TargetBitrate  int
}

VideoEncoderConfigurationCopy Anchor Link

The video encoding properties.

type VideoEncoderConfiguration struct {
    CodecType          VideoCodecType
    Width              int
    Height             int
    Framerate          int
    Bitrate            int
    MinBitrate         int
    OrientationMode    OrientationMode
    DegradePreference  DegradationPreference
    MirrorMode         VideoMirrorModeType
    EncodeAlpha        bool
}

VideoFrameCopy Anchor Link

Properties of the video frame. The video data format is YUV420. The buffer is given as a pointer to a pointer, and this interface cannot modify the buffer's pointer, only the content of the buffer.

type VideoFrame struct {
    Type            VideoBufferType
    Width           int
    Height          int
    YStride         int
    UStride         int
    VStride         int
    YBuffer         []byte
    UBuffer         []byte
    VBuffer         []byte
    Rotation        VideoOrientation
    RenderTimeMs    int64
    AVSyncType      int
    MetadataBuffer  []byte
    SharedContext   unsafe.Pointer
    TextureID       int
    Matrix          [16]float32
    AlphaBuffer     []byte
    AlphaMode       int
}

VideoSubscriptionOptionsCopy Anchor Link

The video subscription options.

type VideoSubscriptionOptions struct {
    StreamType        VideoStreamType
    EncodedFrameOnly  bool
}

EnumsCopy Anchor Link

AreaCodeCopy Anchor Link

Server access regions. This function is an advanced setting suitable for use-cases with access security restrictions. The area code supports bitwise operations. After specifying the access region, the SDK will connect to the Agora servers within the specified region.

AudioCodecTypeCopy Anchor Link

Audio codec types.

AudioFrameTypeCopy Anchor Link

Audio frame types.

AudioScenarioCopy Anchor Link

Audio encoding properties.

ChannelProfileCopy Anchor Link

Channel use-case.

ClientRoleCopy Anchor Link

User roles.

UserMediaInfoCopy Anchor Link

User media information.

VideoBufferTypeCopy Anchor Link

Video data types.

VideoCodecTypeCopy Anchor Link

Video codec types.

VideoFrameTypeCopy Anchor Link

Encoded video frame types.

VideoOrientationCopy Anchor Link

Fields related to raw data. Specifies whether to rotate the incoming video clockwise.

VideoPixelFormatCopy Anchor Link

Pixel formats.

VideoSendCcStateCopy Anchor Link

Congestion control modes.

VideoStreamTypeCopy Anchor Link

Video stream types.