# Custom video source (/en/realtime-media/interactive-live-streaming/build/process-raw-and-custom-media/custom-video/macos)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

Custom video capture refers to the collection of a video stream from a custom source. Unlike the default video capture method, custom video capture enables you to control the capture source, and precisely adjust video attributes. You can dynamically adjust parameters such as video quality, resolution, and frame rate to adapt to various application use-cases. For example, you can capture video from high-definition cameras, and drone cameras.

Agora recommends default video capture for its stability, reliability, and ease of integration. Custom video capture offers flexibility and customization for specific video capture use-cases where default video capture does not fulfill your requirements.

      
  
      
  
      
    ## Understand the tech [#understand-the-tech-2]

    Video SDK provides a custom video track method for video self-collection. You can create and publish custom video tracks to one or more channels. You use the self-capture module to drive the capture device, and send the captured video frames to the SDK through the video track.

    The following figure illustrates the video data transmission process when custom video capture is implemented:

    ![Custom video source](https://assets-docs.agora.io/images/video-sdk/publish-custom-tracks-in-a-channel.svg)

    ## Prerequisites [#prerequisites-2]

    Ensure that you have implemented the [SDK quickstart](/en/realtime-media/video/get-started-sdk) in your project.

    ## Implement the logic [#implement-the-logic-2]

    This section shows you how to implement custom video capture and custom video rendering in your app.

    ### Custom video capture [#custom-video-capture-2]

    The figure below shows the workflow you need to implement to stream a custom video source in your app.

    **Custom video capture**

    ![API call sequence](https://assets-docs.agora.io/images/video-sdk/custom-video-capture.svg)

    Take the following steps to implement this workflow:

    1. Create a custom video track

    To create a custom video track and obtain the video track ID, call `createCustomVideoTrack` after initializing an instance of `AgoraRtcEngineKit`. To create multiple custom video tracks, call the method multiple times.

    ```swift
    customCamera?.trackId = agoraKit.createCustomVideoTrack()
    ```

    2. Join a channel and publish the custom video track

       ```swift
       // Create an AgoraRtcChannelMediaOptions instance
       let option = AgoraRtcChannelMediaOptions()
       // Set the client role to broadcaster
       option.clientRoleType = .broadcaster
       // Enable auto subscription for audio and video
       option.autoSubscribeAudio = true
       option.autoSubscribeVideo = true
       // Publish the self-collected video stream
       option.publishCustomVideoTrack = true
       // Set the custom video track ID
       option.customVideoTrackId = Int(customCamera?.trackId ?? 0)
       // Generate a token for the channel
       NetworkManager.shared.generateToken(channelName: channel, success: { token in
         // Join a channel with the specified options
         let result = self.agoraKit.joinChannel(byToken: token, channelId: channel, uid: 0, mediaOptions: option)
         if result != 0 {
           self.isProcessing = false
           self.showAlert(title: "Error", message: "joinChannel call failed: \(result), please check your params")
         }
       })
       ```

    3. Implement your self-capture module

    Agora provides the [
    CustomVideoSourcePushMulti](https://github.com/AgoraIO/API-Examples/blob/main/macOS/APIExample/Examples/Advanced/CustomVideoSourcePushMulti/CustomVideoSourcePushMulti.swift) demo project that shows you how to read `YUV` format video data from a local file. In a production environment, create a custom video module for your device using Video SDK based on your business requirements.

    4. Push video data to the SDK

    Use `pushExternalVideoFrame` to send the captured video frame to the SDK through the video track. Ensure that the `videoTrackId` matches the video track ID specified when joining the channel. In `AgoraVideoFrame`, you can set the pixel format, data type, timestamp, and other parameters of the video frame.

    The following code demonstrates how to push video data in the `CVPixelBufferRef` format. For other supported video frame formats, refer to the `format` field in [AgoraVideoFrame](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agoravideoframe).

    ```swift
    let videoFrame = AgoraVideoFrame()
    videoFrame.format = 12
    videoFrame.textureBuf = buffer
    videoFrame.rotation = Int32(rotation)
    agoraKit?.pushExternalVideoFrame(videoFrame, videoTrackId: trackId)
    ```

    <CalloutContainer type="info">
      <CalloutDescription>
        To ensure audio and video synchronization, Agora recommends setting the `time` (timestamp) of `AgoraVideoFrame` to the system monotonic time. To retrieve the current monotonic time, call `getCurrentMonotonicTimeInMs`.
      </CalloutDescription>
    </CalloutContainer>

    <CalloutContainer type="info">
      <CalloutDescription>
        If the captured custom video format is Texture and remote users experience flickering or distortion in the captured video, it is recommended to first duplicate the video data and then send both the original and duplicated video data back to the Video SDK. This helps eliminate anomalies during internal data encoding processes.
      </CalloutDescription>
    </CalloutContainer>

    5. Destroy custom video track

    To stop publishing the custom video track, call `destroyCustomVideoTrack`.

    ```swift
    // Destroy the custom video track
    agoraKit.destroyCustomVideoTrack(UInt(userModel?.trackId ?? 0))
    // Leave the channel
    agoraKit.leaveChannelEx(connection) { state in
      LogUtils.log(message: "warning: \(state.description)", level: .info)
    }
    ```

    ### Custom video rendering [#custom-video-rendering-2]

    To implement custom video rendering in your app, refer to the following steps:

    1. Set up `onCaptureVideoFrame` or `onRenderVideoFrame` callback to obtain the video data to be played.
    2. Implement video rendering and playback yourself.
       <CalloutContainer type="info">
         <CalloutDescription>
           In `renderPixelBuffer` or `renderRawData`, the `rotation` parameter of the video frame may not be 0. You need to set the rotation parameters yourself.
         </CalloutDescription>
       </CalloutContainer>

    ## Reference [#reference-2]

    This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

    ### Applicable use-cases [#applicable-use-cases-2]

    Use custom video capture in the following industries and use-cases:

    **Specialized video processing and enhancement**

    In specific gaming or virtual reality use-cases, real-time effects processing, filter handling, or other enhancement effects necessitate direct access to the original video stream. Custom video capture facilitates this, enabling seamless real-time processing and enhances the overall gaming or virtual reality experience for a more realistic outcome.

    **High-precision video capture**

    In video surveillance applications, detailed observation and analysis of scene details is necessary. Custom video capture enables higher image quality and finer control over capture to meet the requirements of video monitoring.

    **Capture from specific video sources**

    Industries such as IoT and live streaming often require the use of specific cameras, monitoring devices, or non-camera video sources, such as video capture cards or screen recording data. In such situations, default Video SDK capture may not meet your requirements, necessitating use of custom video capture.

    **Seamless integration with specific devices or third-party applications**

    In smart home or IoT applications, transmitting video from devices to users' smartphones or computers for monitoring and control may require the use of specific devices or applications for video capture. Custom video capture facilitates seamless integration of specific devices or applications with the Video SDK.

    **Specific video encoding formats**

    In certain live streaming use-cases, specific video encoding formats may be needed to meet business requirements. In such cases, Video SDK default capture might not suffice, and custom video capture is required to capture and encode videos in specific formats.

    ### Advantages [#advantages-2]

    Using custom video capture offers the following advantages:

    **More types of video streams**

    Custom video capture allows the use of higher quality and a greater variety of capture devices and cameras, resulting in clearer and smoother video streams. This enhances the user viewing experience and makes the product more competitive.

    **More flexible video effects**

    Custom video capture enables you to implement richer and more personalized video effects and filters, enhancing the user experience. You can implement effects such as beautification filters and dynamic stickers.

    **Adaptation to diverse use-case requirements**

    Custom video capture helps applications better adapt to the requirements of various use-cases, such as live streaming, video conferencing, and online education. You can customize different video capture solutions based on the use-case requirements to provide a more robust application.

    ### Sample projects [#sample-projects-2]

    Agora provides the following open-source sample projects for your reference. Download the project or view the source code for a more detailed example.

    * [CustomVideoSourcePush](https://github.com/AgoraIO/API-Examples/blob/main/macOS/APIExample/Examples/Advanced/CustomVideoSourcePush/CustomVideoSourcePush.swift): Video self-capture
    * [CustomVideoRender](https://github.com/AgoraIO/API-Examples/blob/main/macOS/APIExample/Examples/Advanced/CustomVideoRender/CustomVideoRender.swift): Custom video rendering

    ### API reference [#api-reference-2]

    * [`createCustomVideoTrack`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorartcenginekit/createcustomvideotrack\(\))
    * [`destroyCustomVideoTrack`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorartcenginekit/destroycustomvideotrack\(_:\))
    * [`setExternalVideoSource`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorartcenginekit/setexternalvideosource\(_\:usetexture\:sourcetype\:encodedvideotrackoption:\))
    * [`pushExternalVideoFrame` \[2/2\]](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorartcenginekit/pushexternalvideoframe\(_\:videotrackid:\))
    * [`onRenderVideoFrame(_:uid:channelId:)`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agoravideoframedelegate/onrendervideoframe\(_\:uid\:channelid:\))
    * [`onCapture(_:sourceType:)`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agoravideoframedelegate/oncapture\(_\:sourcetype:\))
    * [`getCurrentMonotonicTimeInMs`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorartcenginekit/getcurrentmonotonictimeinms\(\))
    * [`joinChannel`](https://api-ref.agora.io/en/video-sdk/macos/4.x/documentation/agorartckit/agorartcenginekit/joinchannel\(bytoken\:channelid\:info\:uid\:joinsuccess:\))

    
  
      
  
      
  
      
  
