tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    Overview

    Last updated: 2024-11-29 15:41:58
    Download PDF

      TRTCCloud

      Basic Method

      API
      Description
      Create a `TRTCCloud` singleton.
      Destroy the `TRTCCloud` singleton.
      Set event listening
      Remove event listening

      Room APIs

      API
      Description
      enterRoom
      Enters a room. If the room does not exist, the system will create one automatically.
      exitRoom
      Leave the room.
      Switch roles, applicable only to live streaming scenarios (TRTC_APP_SCENE_LIVE and TRTC_APP_SCENE_VOICE_CHATROOM).
      Switches rooms.
      Request cross-room call (host PK).
      Exit cross-room call.
      Set the audio and video data reception mode, which must be configured before entering the room to take effect.

      CDN Interface Functions

      API
      Description
      Start publishing media stream.
      Update published media stream.
      Stop publishing media stream.

      Video Interface Functions

      API
      Description
      Enable the preview of local video.
      Update local video preview screen.
      Stop local video capture and preview.
      Pauses/resumes publishing local video data.
      Starts playing the video of a remote user.
      Update the video rendering view of the remote user.
      Stops playing and pulling the video of a remote user.
      Stops playing and pulling the videos of all remote users.
      Pauses/Resumes receiving the video of a specified remote user.
      Pauses/Resumes receiving the videos of all remote users.
      Sets video encoder parameters.
      Sets the parameters for network flow control.
      Sets the rendering mode of the local image.
      Sets the parameters related to remote images.
      Enables dual-stream encoding mode for large and small screens.
      Selects the big or small screen for a specified UID.
      Takes a video screenshot.
      Sets the adaptive mode for gravity sensing.

      Audio related interface functions

      API
      Description
      Enables local audio capturing and publishing.
      Disables local audio capturing and publishing.
      Mute/unmute local audio.
      Mute/unmute the sound of a specified remote user.
      Mute/Unmute all user's voices.
      Set the volume of a specific remote user's audio playback.
      Sets the SDK capturing volume.
      Obtains the SDK capture volume.
      Sets the SDK playback volume.
      Gets the SDK playback volume.
      Enables volume level prompt.
      Start local media recording, which includes both audio and video data.
      Stop local media recording.

      Device management interface

      API
      Description
      Obtain device management module. For interface details, see Device Management Interface Documentation

      Music and Vocal Special Effects

      API
      Description
      Obtain TXAudioEffectManager for managing BGM, short sound effects, and vocal special effects. For interface details, see Sound Effect Management Documentation
      Enable system audio capture.
      Stop system audio capture.
      Set system audio capturing volume.

      Auxiliary stream related interface functions

      API
      Description
      Start screen sharing
      Stop screen capturing
      Pause screen sharing
      Resumes screen sharing
      Enumerate shareable screens and windows (this API is only supported on Windows)
      Select the screen or window to be shared (this API is only supported on Windows)
      Set the screen sharing (i.e., substream) video encoding parameters (supported on both desktop and mobile systems)

      Custom capturing and custom rendering

      API
      Description
      Enable/Disable Custom Video Capture Mode.
      Submit your captured video frames to the SDK.
      Enable/Disable Custom Audio Capture Mode.
      Submit your captured audio data to the SDK.
      Enable/Disable Custom Audio Track.

      Custom message sending APIs

      API
      Description
      Sends a custom message to all users in a room.
      Embeds small-volume custom data into video frames.

      Network Testing

      API
      Description
      Starts network speed testing. This may compromise the quality of video calls and should be avoided during a video call.
      Stops server speed measurement.

      Log Interface Functions

      API
      Description
      Gets the SDK version.
      Sets the log output level.
      Enables/Disables console log printing.
      Enables/Disables local log compression.
      Modifies the log save path.
      Sets the log callback.
      Display Debug Information Floating Layer (can show audio and video information and event information).
      Calls the experimental API.

      TRTCCloudListener

      Event callback interface for Tencent Cloud video call feature.

      Error and warning event callback APIs

      API
      Description
      onError
      Error callback, indicating an irrecoverable error in the SDK. It is essential to listen and provide users with appropriate interface prompts accordingly.
      onWarning
      Warning callback, designed to inform you of non-critical issues, such as lag or recoverable decoding failure.

      Room event callback APIs

      API
      Description
      Callback for having joined the room.
      Event callback for leaving the room.
      Event callback for switching roles.
      Result callback for switching rooms (switchRoom).
      Result callback for requesting cross-room call (Host PK).
      Result callback for ending cross-room call (Host PK).

      Member Event Callback

      API
      Description
      A user has joined the current room.
      A user has left the current room.
      Whether the remote user has a main route view that can be played (generally used for cameras).
      Whether the remote user has an auxiliary route view that can be played (generally used for screen sharing).
      Whether the remote user has playable audio data.
      Start rendering the first frame image of a local or remote user.
      Start playing the first frame audio of a remote user (local sound is not notified for the time being).
      The first frame of local video data has been sent out.
      The first frame of local audio data has been sent out.
      Callback for changes in remote video status.
      Callback for changes in remote audio status.
      Callback for changes in user's video size.

      Callback for local recording and local screenshot events

      API
      Description
      When the local recording task has started, the SDK will notify through this callback.
      While the local recording task is in progress, the SDK will periodically notify users through this callback.
      When you enable segmented recording, the SDK will notify you through this callback each time a segment is completed.
      When the local recording task has ended, the SDK will notify you through this callback.
      Callback for local screenshot completion.

      Statistics and quality callback

      API
      Description
      Network quality, this callback is triggered every 2 seconds, providing statistics for the current network's upload and download quality.
      Technical indicators statistics callback.
      Callback for the result of the network speed test.

      Server event callback

      API
      Description
      The SDK's connection to the server has disconnected.
      The SDK attempts to reconnect to the server.
      The SDK's connection to the server has been restored.

      Hardware Device Event Callback

      API
      Description
      Camera Ready.
      Microphone Ready.
      Callback for indicating volume level, including the volume of each userId and the remote master volume.
      The system capture volume of the current microphone has changed.
      The playback volume of the current system has changed.
      Event callback for successful system sound capture (only applicable to desktop systems).
      Microphone test volume callback
      Speaker test volume callback

      Custom message receipt callback

      API
      Description
      Receipt of a custom message callback.
      Custom message loss callback.
      Received SEI message callback.

      CDN Bypass Forward Callback

      API
      Description
      Callback for setting On-Cloud MixTranscoding parameters, corresponding to the startPublishMediaStream() interface in TRTCCloud.
      Callback for setting On-Cloud MixTranscoding parameters, corresponding to the updatePublishMediaStream() interface in TRTCCloud.
      Callback for setting On-Cloud MixTranscoding parameters, corresponding to the stopPublishMediaStream() interface in TRTCCloud.
      Callback for changes in RTMP/RTMPS stream pushing status.

      Screen sharing callback

      API
      Description
      When screen sharing starts, the SDK will notify through this callback.
      When the pauseScreenCapture() is called to pause screen sharing, the SDK will notify through this callback.
      When the resumeScreenCapture() is called to resume screen sharing, the SDK will notify through this callback.
      When screen sharing stops, the SDK will notify via this callback.
      Event callback for when the target window of screen sharing is obscured (applicable only to Windows operating systems)

      More event callbacks

      TRTC Log Callback

      API
      Description
      onLog
      Local LOG print callback

      Callback interface for playing background music

      API
      Description
      onStart
      Callback notification for music playback start.
      Callback notification for music playback progress.
      Callback notification for music playback end.

      Background Music Preload Event Callback

      API
      Description
      Background Music Preload Progress.
      Background Music Preload Error.

      Device Connectivity Status Change Callback

      API
      Description
      The connectivity status of the local device has changed (Desktop systems only)

      TXAudioEffectManager

      API
      Description
      Enable ear monitoring, allowing local users to hear their own voice.
      Set ear monitoring volume
      Set voice reverb effects (KTV, small room, auditorium, deep, bright, etc.)
      Set voice changing effects (loli, uncle, heavy metal, punk, etc.)
      Set microphone voice volume
      Set voice pitch.
      Set event callback interface for background music.
      Start playing background music
      Stop playing background music
      Pause playing background music
      Resumes background music
      Sets global background music volume for local and remote users
      Sets the remote volume of background music. The host can use this API to set the volume of background music heard by remote audiences.
      Sets the local volume of background music. The host can use this API to set the volume of local background music.
      Adjusts the pitch of background music
      Adjusts the speed of background music
      Gets the current playback progress of the background music (milliseconds)
      Gets the total duration of the background music file (milliseconds)
      Sets the playback progress of the background music (milliseconds)
      Adjusts the speed effect of the scratch disk
      Set preload event callback
      Preload background music
      Get the number of tracks in background music
      Specify the track to play background music

      TXDeviceManager

      API
      Description
      Set whether to use the front camera
      Switch camera (front/rear)
      Get the maximum zoom level of the camera
      Set the camera zoom factor (focal length)
      Check if the device supports automatic face position recognition
      Set whether to enable automatic face position recognition
      Set the camera focus position
      Enable/disable flashlight, also known as torch mode
      Set audio routing, i.e., use receiver or speaker
      Get the device list of specified type
      Set the device currently in use
      Get the device currently in use
      Set the volume of the current device
      Get the volume of the current device
      Set the mute state of the current device
      Query the mute state of the current device
      Set the audio device used by the SDK to follow the system default device (desktop only)
      Start camera testing (desktop only)
      Stop camera testing (desktop only)
      Start mic testing (desktop only)
      Start mic testing (desktop only)
      Stop mic testing (desktop only)
      Start speaker testing (desktop only)
      Stop speaker testing (desktop only)
      Set the volume of the current process in the Windows system volume mixer
      Get the volume of the current process in the Windows system volume mixer
      Set the mute state of the current process in the Windows system volume mixer
      Get the mute state of the current process in the Windows system volume mixer
      Set camera capture preferences
      Set onDeviceChanged event callback

      Enumeration definitions

      Enum Type
      Description
      Application scenario
      Audio Frame Content Format
      Audio Callback Data Operation Mode
      Sound Quality
      Audio Recording Content Type
      Playback State Change Reason
      Audio and video playback status
      Media recording type
      Sets the adaptive mode for gravity sensing (only applicable to mobile devices)
      Media recording type.
      Log level
      Publishing mode
      Network quality
      Roles
      Screen sharing target type (desktop only)
      Local video screenshot data source
      Speed test scenario
      Video data shipping method
      Video image fill mode
      Video mirroring type
      Video pixel format
      Image quality preference
      Video resolution
      Video aspect ratio mode
      Video image rotation direction
      Video stream type
      Watermark image source type
      Reverb special effect
      Voice change special effect
      Audio routing (i.e., sound playback mode)
      Device type (desktop platform only)
      Device operation
      Camera capture preferences

      Type Definition

      Struct type
      Description
      Audio frame data
      Format parameters for custom audio callbacks
      Volume evaluation and other related parameter settings
      Structure for storing window thumbnails and icons
      Local media file recording parameters
      Local audio and video metrics
      Network bandwidth limit parameters
      Room entry parameters
      Target URL for publishing to Tencent Cloud or a third-party CDN
      Publishing target
      Network quality
      Remote audio and video metrics
      Rendering parameters of the video image
      Advanced control parameters for screen sharing
      Target information for screen sharing (desktop only)
      List of screen windows
      Network speed test parameters
      Network speed test results
      Network and performance metrics
      Encoding parameters
      Transcoding parameters
      Room switch parameters
      Video texture data
      TRTCUser
      User to publish stream
      Video codec parameters
      Video frame information
      Video layout for transcoded stream
      Volume
      Watermark layout
      Background music playback control information
      Camera capture parameters
      Information about audio and video devices (desktop platform only)

      Video rendering component

      API
      Description
      Video view window for displaying local video, remote video, or auxiliary stream.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy