tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Mobile Live Video Broadcasting
    Documentation
    Download PDF

    API Overview

    Last updated: 2024-10-25 16:52:53
    Download PDF
      API OVERVIEW

      LivePusher Interface

      FuncList
      DESC
      Sets the pusher callback
      Sets the local camera preview
      Sets the view mirror of the local camera
      Sets the video encoder mirror
      Sets the rotation angle of the view
      Sets the fill mode of the local video image
      Enables the local camera
      Disables the local camera
      Enables the local microphone
      Disables the microphone
      Enables the image streaming
      Disables the image streaming
      Enables video capturing
      Disables video capture
      Mute local audio
      Resume the audio stream of the pusher
      Pause the video stream of the pusher
      Resume the video stream of the pusher
      Starts pushing the audio and video data
      Stops pushing the audio and video data
      Indicates whether the pusher is currently pushing streams
      Sets the audio quality for pushing
      Set the video encoding parameters for pushing
      Obtains the beauty manager
      Obtains the audio effect manager
      Obtains the video device manager
      Captures the local view in the pushing process
      Sets the pusher watermark image. By default, the watermark is disabled
      Enables volume update
      Enables or disables custom video processing
      Enables or disables custom video capture
      Turn on/off custom audio capture
      Sends the collected video data to the SDK in the custom video capture mode
      In the custom audio collection mode, send the collected audio data to the SDK
      Enables/Disables audio process callback
      Use SEI channel to send custom message
      Indicates whether the debug view of the pusher video status information is displayed
      Calls the advanced API of V2TXLivePusher
      Sets On-Cloud MixTranscoding parameters
      Start recording audio and video stream
      Stop recording audio and video stream
      Enable voice activity detection

      Live pusher Event Callback

      FuncList
      DESC
      Live pusher error notification, which is called back when the pusher encounters an error
      Live pusher warning notification
      Callback notification indicating that collection of the first audio frame is complete
      Callback notification indicating that collection of the first video frame is complete
      Microphone-collected volume callback
      Callback notification of the pusher connection status
      Live pusher statistics callback
      Screenshot callback
      Audio data captured by the local mic, pre-processed by the audio module, effect-processed and BGM-mixed
      Custom video processing callback
      Callback of destroying the OpenGL context in the SDK
      Callback of setting On-Cloud MixTranscoding parameters, which corresponds to the setMixTranscodingConfig API
      The SDK returns this callback when you call startScreenCapture and other APIs to start screen sharing.
      The SDK returns this callback when you call stopScreenCapture to stop screen sharing
      The SDK returns this callback when you call startLocalRecording to start local recording.
      The SDK returns this callback when you call startLocalRecording to start local recording, which means recording task in progress.
      The SDK returns this callback when you call stopLocalRecording to start local recording.
      After calling enableVoiceActivityDetection to turn on voice activity detection, you will receive this callback notification when the anchor starts or stops speaking.

      V2TXLivePlayer Interface

      FuncList
      DESC
      Sets the player callback
      Sets the rendering view of the player. This control is responsible for presenting the video content
      Sets the rotation angle of the player view
      Sets the fill mode of the view
      Starts playing the audio and video streams
      Stops playing the audio and video streams
      Indicates whether the player is playing the audio and video streams
      Pauses the audio stream of the player
      Resumes the audio stream of the player
      Pauses the video stream of the player
      Resumes the video stream of the player
      Sets the volume
      Set the minimum time and maximum time (unit: s) for auto adjustment of the player cache
      Seamlessly switch live stream urls, supporting FLV and LEB protocols
      Get Stream lnfo List
      Enables playback volume update
      Captures the video view in the playback process
      Turn on/off the monitoring callback of the video frame
      Turn on/off the monitoring callback of the audio frame
      Enables the receiving of SEI messages
      Enables Picture-in-Picture mode
      Indicates whether the debug view of the player video status information is displayed
      Calls the advanced API of V2TXLivePlayer
      Start recording audio and video stream
      Stop recording audio and video stream

      Live Player Event Callback

      FuncList
      DESC
      live player error notification, which is called back when the player encounters an error
      live player warning notification
      live player resolution change notification
      live player has successfully connected to the server notification
      Video playback event
      Audio playback event
      Video loading event
      Audio loading event
      Player playback volume callback
      Live player statistics callback
      Screenshot callback
      Custom video rendering callback
      Audio Data callback
      Callback of receiving an SEI message. The sender calls sendSeiMessage in V2TXLivePusher to send an SEI
      Resolution stream switch callback
      Picture-in-Picture state change callback
      The SDK returns this callback when you call startLocalRecording to start local recording.
      The SDK returns this callback when you call startLocalRecording to start local recording, which means recording task in progress.
      The SDK returns this callback when you call stopLocalRecording to start local recording.

      V2TXLive High-level interface

      FuncList
      DESC
      Get the SDK version number
      Set V2TXLivePremier callback interface
      Set Log configuration information
      Set up SDK access environment
      Set SDK authorization license
      Set SDK socks5 proxy config
      Enables/Disables audio capture callback
      Enables/Disables audio playout callback
      Enables/Disables in-ear monitoring callback
      Set user id
      Call experimental APIs

      V2TXLive Advanced callback interface

      FuncList
      DESC
      Custom Log output callback interface
      setLicence result callback interface
      Raw audio data captured locally
      Data mixed from each channel before being submitted to the system for playback
      In-ear monitoring data

      Voice effect APIs

      FuncList
      DESC
      Enabling in-ear monitoring
      Setting in-ear monitoring volume
      Setting voice reverb effects
      Setting voice changing effects
      Setting speech volume
      Setting speech pitch

      Background music APIs

      FuncList
      DESC
      Starting background music
      Stopping background music
      Pausing background music
      Resuming background music
      Setting the local and remote playback volume of background music
      Setting the remote playback volume of a specific music track
      Setting the local playback volume of a specific music track
      Adjusting the pitch of background music
      Changing the speed of background music
      Getting the playback progress (ms) of background music
      Getting the total length (ms) of background music
      Setting the playback progress (ms) of background music
      Adjust the speed change effect of the scratch disc
      Preload background music
      Get the number of tracks of background music
      Specify the playback track of background music

      beauty interface

      FuncList
      DESC
      Sets the beauty (skin smoothing) filter algorithm.
      Sets the strength of the beauty filter.
      Sets the strength of the brightening filter.
      Enables clarity enhancement.
      Sets the strength of the rosy skin filter.
      Sets color filter.
      Sets the strength of color filter.
      Sets green screen video
      Sets the strength of the eye enlarging filter.
      Sets the strength of the face slimming filter.
      Sets the strength of the chin slimming filter.
      Sets the strength of the chin lengthening/shortening filter.
      Sets the strength of the face shortening filter.
      Sets the strength of the face narrowing filter.
      Sets the strength of the nose slimming filter.
      Sets the strength of the eye brightening filter.
      Sets the strength of the teeth whitening filter.
      Sets the strength of the wrinkle removal filter.
      Sets the strength of the eye bag removal filter.
      Sets the strength of the smile line removal filter.
      Sets the strength of the hairline adjustment filter.
      Sets the strength of the eye distance adjustment filter.
      Sets the strength of the eye corner adjustment filter.
      Sets the strength of the mouth shape adjustment filter.
      Sets the strength of the nose wing narrowing filter.
      Sets the strength of the nose position adjustment filter.
      Sets the strength of the lip thickness adjustment filter.
      Sets the strength of the face shape adjustment filter.
      Selects the AI animated effect pendant.
      Sets whether to mute during animated effect playback.

      Type definitions of audio/video devices

      FuncList
      DESC
      The status of a local device changed (for desktop OS only)

      Device APIs

      FuncList
      DESC
      Querying whether the front camera is being used
      Switching to the front/rear camera (for mobile OS)
      Querying whether the current camera supports zooming (for mobile OS)
      Getting the maximum zoom ratio of the camera (for mobile OS)
      Setting the camera zoom ratio (for mobile OS)
      Querying whether automatic face detection is supported (for mobile OS)
      Enabling auto focus (for mobile OS)
      Adjusting the focus (for mobile OS)
      Querying whether flash is supported (for mobile OS)
      Enabling/Disabling flash, i.e., the torch mode (for mobile OS)
      Setting the audio route (for mobile OS)
      Set the exposure parameters of the camera, ranging from - 1 to 1
      Getting the device list (for desktop OS)
      Setting the device to use (for desktop OS)
      Getting the device currently in use (for desktop OS)
      Setting the volume of the current device (for desktop OS)
      Getting the volume of the current device (for desktop OS)
      Muting the current device (for desktop OS)
      Querying whether the current device is muted (for desktop OS)
      Set the audio device used by SDK to follow the system default device (for desktop OS)
      Starting camera testing (for desktop OS)
      Ending camera testing (for desktop OS)
      Starting mic testing (for desktop OS)
      Starting mic testing (for desktop OS)
      Ending mic testing (for desktop OS)
      Starting speaker testing (for desktop OS)
      Ending speaker testing (for desktop OS)
      set onDeviceChanged callback (for Mac)
      Set camera acquisition preferences

      Disused APIs

      FuncList
      DESC
      Setting the system volume type (for mobile OS)
      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