tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Mobile Live Video Broadcasting
    Documentation
    Download PDF

    Publishing from Camera

    Last updated: 2024-01-13 15:49:41
    Download PDF

      Overview

      Publishing from camera refers to the process of collecting video and audio data from the mobile phone’s camera and mic, encoding the data, and publishing it to cloud-based live streaming platforms. Tencent Cloud’s LiteAVSDK provides the camera publishing capability via V2TXLivePusher, the following is the relevant operation interface of the demo camera in the simple version of LiteAVSDK:
      
      

      Notes

      About running projects on x86 emulators: The SDK uses a lot of audio and video APIs of the iOS system, most of which cannot be used on the x86 emulator built into macOS. Therefore, we recommend that you test your project on a real device.

      Sample Code

      Platform
      GitHub Address
      Key Class
      iOS
      CameraPushViewController.m
      Android
      CameraPushMainActivity.java
      Flutter
      live_camera_push.dart

      Integration

      1. Download the SDK

      Download the SDK and follow the instructions in SDK Integration to integrate the SDK into your application.

      2. Configure License Authorization for SDK

      1. Obtain license authorization：
      If you have obtained the relevant license authorization，Need to Get License URL and License Key in Cloud Live Console
      
      
      If you have not yet obtained the license authorization，Please reference Adding and Renewing Licenses to make an application.
      2. Before your App calls SDK-related functions (it is recommended in the - [AppDelegate application:didFinishLaunchingWithOptions:]), set the following settings:
      - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
          NSString * const licenceURL = @"<your licenseUrl>";
          NSString * const licenceKey = @"<your key>";
      
          // V2TXLivePremier is located in "V2TXLivePremier.h"
          [V2TXLivePremier setEnvironment:@"GDPR"]; // set environment
          [V2TXLivePremier setLicence:licenceURL key:licenceKey];
          [V2TXLivePremier setObserver:self];
          NSLog(@"SDK Version = %@", [V2TXLivePremier getSDKVersionStr]);
          return YES;
      }
      
      #pragma mark - V2TXLivePremierObserver
      - (void)onLicenceLoaded:(int)result Reason:(NSString *)reason {
          NSLog(@"onLicenceLoaded: result:%d reason:%@", result, reason);
      }
      @end
      Note:
      The BundleId configured in the license must be the same as the application itself, otherwise the streaming will fail.

      3. Initialize the V2TXLivePusher component

      Create a V2TXLivePusher object and specify V2TXLiveMode.
      // Specify the corresponding live broadcast protocol as RTMP, which does not support mic connection
      V2TXLivePusher *pusher = [[V2TXLivePusher alloc] initWithLiveMode:V2TXLiveMode_RTMP];

      4. Enable camera preview

      Call setRenderView in V2TXLivePusher to configure a view object for displaying video images, and then call startCamera to enable camera preview for your mobile phone.
       // Create a view object and insert it into the UI
       UIView *_localView = [[UIView alloc] initWithFrame:self.view.bounds];
       [self.view insertSubview:_localView atIndex:0];
       _localView.center = self.view.center;
      
       // Enable preview for the local camera
       [_pusher setRenderView:_localView];
       [_pusher startCamera:YES];
       [_pusher startMicrophone];
      Note:
      To add animated effects to the view, modify its transform attribute rather than frame attribute.
      [UIView animateWithDuration:0.5 animations:^{
            _localView.transform = CGAffineTransformMakeScale(0.3, 0.3); // Shrink by 1/3
      }];

      5. Start and stop publishing

      After calling startCamera to enable camera preview, you can call the startPush API in V2TXLivePusher to start publishing.
      Note:
      If the RTMP protocol is selected in Step 3 to push the stream, please refer to the generation of the push stream URL RTMP URL。
      //This URL does not support co-anchoring. The stream is published to a live streaming CDN.
      NSString* url = @"rtmp://test.com/live/streamid?txSecret=xxxxx&txTime=xxxxxxxx";
      [_pusher startPush:url];
      Call stopPush in V2TXLivePusher to stop publishing streams.
      //Stop publishing
      [_pusher stopPush];
      Why is V2TXLIVE_ERROR_INVALID_LICENSE returned?If the startPush API returns V2TXLIVE_ERROR_INVALID_LICENSE, it means your license verification failed. Please check your configuration against Step 2. Configure License Authorization for SDK.

      6. Publish audio-only streams

      If your live streaming scenarios involve audio only, you can skip Step 4 or do not call startCamera before startPush.
      [_pusher startMicrophone];
      //This URL does not support co-anchoring. The stream is published to a live streaming CDN.
      NSString* url = @"rtmp://test.com/live/streamid?txSecret=xxxxx&txTime=xxxxxxxx";
      [_pusher startPush:url];
      Note:
      If you publish audio-only streams but no streams can be pulled from an RTMP, FLV, or HLS playback URL, there is a problem with your line configuration, please submit a ticket for help.

      7. Set video quality

      Call setVideoQuality in V2TXLivePusher to set the quality of videos watched by audience. The encoding parameters set determine the quality of videos presented to audience. The local video watched by the host is the original HD version that has not been encoded or compressed, and is therefore not affected by the settings. For details, please see Setting Video Quality.

      8. Set the beauty filter style and skin brightening and rosy skin effects

      Call getBeautyManager in V2TXLivePusher to get a TXBeautyManager instance to set beauty filters.

      Beauty filter style

      The SDK has three built-in beauty filter algorithms, each corresponding to a beauty filter style. Choose one that best fits your product positioning. For details, please see the TXBeautyManager.h file.
      Beauty Filter Style
      Description
      TXBeautyStyleSmooth
      The smooth style, which features more obvious skin smoothing effects and is suitable for live showrooms
      TXBeautyStyleNature
      The natural style, which retains more facial details and is more natural
      TXBeautyStylePitu
      The Pitu style, which uses the beauty filter algorithm developed by YouTu Lab. Its effect is between the smooth style and the natural style, that is, it retains more skin details than the smooth style and delivers more obvious skin smoothing effects than the natural style.
      You can call the setBeautyStyle API in TXBeautyManager to set the beauty filter style.
      Item
      Configuration
      Description
      Beauty filter strength
      Via the setBeautyLevel API in `TXBeautyManager`
      Value range: 0-9. `0` means the filter is disabled. The greater the value, the more obvious the effect.
      Skin brightening filter strength
      Via the setWhitenessLevel API in `TXBeautyManager`
      Value range: 0-9. `0` means the filter is disabled. The greater the value, the more obvious the effect.
      Rosy skin filter strength
      Via the setRuddyLevel API in `TXBeautyManager`
      Value range: 0-9. `0` means the filter is disabled. The greater the value, the more obvious the effect.

      9. Set color filters

      Call getBeautyManager in V2TXLivePusher to get a TXBeautyManager instance to set color filters.
      Call the setFilter API in TXBeautyManager to set color filters. Color filters are a technology that adjusts the color tone of sections of an image. For example, it may lighten the yellow sections of an image to achieve the effect of skin brightening, or add warm tones to a video to give it a refreshing and soft boost.
      Call the setFilterStrength API in TXBeautyManager to set the strength of a color filter. The higher the strength, the more obvious the effect.
      Based on our experience of operating Mobile QQ and Now Live, it’s not enough to use only the setBeautyStyle API in TXBeautyManager to set the beauty filter style. The setBeautyStyle API must be used together with setFilter to produce richer effects. Given this, our designers have developed 17 built-in color filters for you to choose from.
      NSString * path = [[NSBundle mainBundle] pathForResource:@"FilterResource" ofType:@"bundle"];
      path = [path stringByAppendingPathComponent:lookupFileName];
      
      UIImage *image = [UIImage imageWithContentsOfFile:path];
      [[_pusher getBeautyManager] setFilter:image];
      [[_pusher getBeautyManager] setFilterStrength:0.5f];

      10. Manage devices

      V2TXLivePusher provides a series of APIs for the control of devices. You can call getDeviceManager to get a TXDeviceManager instance for device management. For detailed instructions, please see TXDeviceManager API.

      11. Set the video mirroring effect for audience

      Call setEncoderMirror in V2TXLivePusher to set the camera mirror mode, which affects the way video images are presented to audience. By default, the local image seen by the host is flipped when the front camera is used.
      
      

      12. Publish streams in landscape mode

      In most cases, hosts stream while holding their phones vertically, and audience watch videos in portrait resolutions (e.g., 540 × 960). However, there are also cases where hosts hold phones horizontally, and ideally, audience should watch videos in landscape resolutions (960 × 540).
      By default, V2TXLivePusher outputs videos in portrait resolutions. You can publish landscape-mode videos to audience by modifying a parameter of the setVideoQuality API.
      [_pusher setVideoQuality:videoQuality
                   resolutionMode:isLandscape ? V2TXLiveVideoResolutionModeLandscape : V2TXLiveVideoResolutionModePortrait];

      13. Set audio effects

      Call getAudioEffectManager in V2TXLivePusher to get a TXAudioEffectManager instance, which can be used to mix background music and set in-ear monitoring, reverb, and other audio effects. Background music mixing means mixing into the published stream the music played by the host’s phone so that audience can also hear the music.
      Call the enableVoiceEarMonitor API in TXAudioEffectManager to enable in-ear monitoring, which allows hosts to hear their vocals in earphones when they sing.
      Call the setVoiceReverbType API in TXAudioEffectManager to add reverb effects such as karaoke, hall, husky, and metal. The effects are applied to the videos watched by audience.
      Call the setVoiceChangerType API in TXAudioEffectManager to add voice changing effects such as little girl and middle-aged man to enrich host-audience interaction. The effects are applied to the videos watched by audience.
      
      Note:
      For detailed instructions, please see TXAudioEffectManager API.

      14. Set watermarks

      Call setWatermark in V2TXLivePusher to add a watermark to videos output by the SDK. The position of the watermark is determined by the (x, y, scale) parameter passed in.
      The watermark image must be in PNG rather than JPG format. The former carries opacity information, which allows the SDK to better address the image aliasing issue (changing the extension of a JPG image to PNG won’t work).
      The (x, y, scale) parameter specifies the normalized coordinates of the watermark relative to the resolution of the published video. For example, if the resolution of the published video is 540 x 960, and (x, y, scale) is set to （0.1, 0.1, 0.1）, the actual pixel coordinates of the watermark will be (540 x 0.1, 960 x 0.1). The width of the watermark will be the video width x 0.1, and the height will be scaled automatically.
      // Set a video watermark
      [_pusher setWatermark:[UIImage imageNamed:@"watermark"] x:0.03 y:0.015 scale:1];

      15. Inform hosts of poor network conditions

      Connecting phones to Wi-Fi does not necessarily guarantee network conditions. In case of poor Wi-Fi signal or limited bandwidth, the network speed of a Wi-Fi connected phone may be slower than that of a phone using 4G. Hosts should be informed when their network conditions are bad and be prompted to switch to a different network.
      
      You can capture the V2TXLIVE_WARNING_NETWORK_BUSY event using onWarning in V2TXLivePusherObserver. The event indicates poor network conditions for hosts, which result in stuttering for audience. When this event occurs, you can send a UI message about poor network conditions to hosts, as shown above.
      - (void)onWarning:(V2TXLiveCode)code
                message:(NSString *)msg
              extraInfo:(NSDictionary *)extraInfo {
          dispatch_async(dispatch_get_main_queue(), ^{
              if (code == V2TXLIVE_WARNING_NETWORK_BUSY) {
                  [_notification displayNotificationWithMessage:
                      @"Your network conditions are poor. Please switch to a different network." forDuration:5];
              }
          });
      }

      16. Send SEI messages

      Call the sendSeiMessage API in V2TXLivePusher to send SEI messages. SEI refers to the supplementary enhancement information of encoded video. It is not used most of the time, but you can insert custom information into SEI messages. The information will be forwarded to audience by live streaming CDNs. The applications for SEI messages include:
      Live quiz: The publisher can use SEI messages to send questions to the audience. SEI can ensure synchronization among audio, video, and the questions.
      Live showroom: The publisher can use SEI messages to display lyrics to the audience in real time. The effects are not affected by reduction in video encoding quality.
      Online education: The publisher can use SEI messages to display pointers and sketches on slides to the audience in real time.
      Custom data is inserted directly into video data and therefore cannot be too large in size (preferably several bytes). It’s common to insert information such as custom timestamps.
      int payloadType = 5;
      NSString* msg = @"test";
      [_pusher sendSeiMessage:payloadType data:[msg dataUsingEncoding:NSUTF8StringEncoding]];
      Common open-source players or web players are incapable of parsing SEI messages. You must use V2TXLivePlayer, the built-in player of LiteAVSDK.
      1. Configuration:
      int payloadType = 5;
      [_player enableReceiveSeiMessage:YES payloadType:payloadType];
      2. If the video streams played by V2TXLivePlayer contain SEI messages, you will receive the messages via the onReceiveSeiMessage callback in V2TXLivePlayerObserver.

      Event Handling

      Listening for events

      The SDK listens for publishing events and errors via the V2TXLivePusherObserver delegate. See V2TXLiveCode for a detailed list of events and error codes.

      Errors

      An error indicates that the SDK encountered a serious problem that made it impossible for stream publishing to continue.
      Event ID
      Code
      Description
      V2TXLIVE_ERROR_FAILED
      -1
      A common error not yet classified
      V2TXLIVE_ERROR_INVALID_PARAMETER
      -2
      An invalid parameter was passed in during API calling.
      V2TXLIVE_ERROR_REFUSED
      -3
      The API call was rejected.
      V2TXLIVE_ERROR_NOT_SUPPORTED
      -4
      The API cannot be called.
      V2TXLIVE_ERROR_INVALID_LICENSE
      -5
      Failed to call the API due to invalid license.
      V2TXLIVE_ERROR_REQUEST_TIMEOUT
      -6
      The server request timed out.
      V2TXLIVE_ERROR_SERVER_PROCESS_FAILED
      -7
      The server could not handle your request.

      Warnings

      A warning indicates that the SDK encountered a problem whose severity level is warning. Warning events trigger tentative protection or recovery logic and can often be resolved.
      Event ID
      Code
      Description
      V2TXLIVE_WARNING_NETWORK_BUSY
      1101
      Bad network connection: data upload blocked due to limited upstream bandwidth.
      V2TXLIVE_WARNING_VIDEO_BLOCK
      2105
      Latency during video playback.
      V2TXLIVE_WARNING_CAMERA_START_FAILED
      -1301
      Failed to turn the camera on.
      V2TXLIVE_WARNING_CAMERA_OCCUPIED
      -1316
      The camera is occupied. Try a different camera.
      V2TXLIVE_WARNING_CAMERA_NO_PERMISSION
      -1314
      No access to the camera. This usually occurs on mobile devices and may be because the user denied the access.
      V2TXLIVE_WARNING_MICROPHONE_START_FAILED
      -1302
      Failed to turn the mic on.
      V2TXLIVE_WARNING_MICROPHONE_OCCUPIED
      -1319
      The mic is occupied. This occurs when, for example, the user is having a call on the mobile device.
      V2TXLIVE_WARNING_MICROPHONE_NO_PERMISSION
      -1317
      No access to the mic. This usually occurs on mobile devices and may be because the user denied the access.
      V2TXLIVE_WARNING_SCREEN_CAPTURE_NOT_SUPPORTED
      -1309
      The system does not support screen sharing.
      V2TXLIVE_WARNING_SCREEN_CAPTURE_START_FAILED
      -1308
      Failed to start screen recording. If this occurs on a mobile device, it may be because the user denied the access.
      V2TXLIVE_WARNING_SCREEN_CAPTURE_INTERRUPTED
      -7001
      Screen recording was stopped by the system.
      
      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