Documentation
¶
Index ¶
Constants ¶
const ( RoleAttendee = 0 RolePublisher = 1 RoleSubscriber = 2 RoleAdmin = 101 )
Role consts
Variables ¶
This section is empty.
Functions ¶
func BuildTokenWithUID ¶ added in v0.1.4
func BuildTokenWithUID(appID string, appCertificate string, channelName string, uid uint32, role Role, privilegeExpiredTs uint32) (string, error)
BuildTokenWithUID method appID: The App ID issued to you by Agora. Apply for a new App ID from
Agora Dashboard if it is missing from your kit. See Get an App ID.
appCertificate: Certificate of the application that you registered in
the Agora Dashboard. See Get an App Certificate.
channelName:Unique channel name for the AgoraRTC session in the string format userAccount: The user account. role: Role_Publisher = 1: A broadcaster (host) in a live-broadcast profile.
Role_Subscriber = 2: (Default) A audience in a live-broadcast profile.
privilegeExpireTs: represented by the number of seconds elapsed since
1/1/1970. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set expireTimestamp as the current
func BuildTokenWithUserAccount ¶ added in v0.1.4
func BuildTokenWithUserAccount(appID string, appCertificate string, channelName string, userAccount string, role Role, privilegeExpiredTs uint32) (string, error)
BuildTokenWithUserAccount method appID: The App ID issued to you by Agora. Apply for a new App ID from
Agora Dashboard if it is missing from your kit. See Get an App ID.
appCertificate: Certificate of the application that you registered in
the Agora Dashboard. See Get an App Certificate.
channelName:Unique channel name for the AgoraRTC session in the string format uid: User ID. A 32-bit unsigned integer with a value ranging from
1 to (232-1). optionalUid must be unique.
role: Role_Publisher = 1: A broadcaster (host) in a live-broadcast profile.
Role_Subscriber = 2: (Default) A audience in a live-broadcast profile.
privilegeExpireTs: represented by the number of seconds elapsed since
1/1/1970. If, for example, you want to access the Agora Service within 10 minutes after the token is generated, set expireTimestamp as the current timestamp + 600 (seconds)./