🧩 Creating Custom Sources

There are 2 types of sources:

• frames are captured in a ByteBuffer: such as a microphone. ByteBuffer sources implement IAudioFrameSourceInternal (for audio) (such as MicrophoneSource) and IVideoFrameSourceInternal ( for video) (not available).
• frames are passed to the encoder surface (video only): when the video source can write to a Surface. Its purpose is to improve encoder performance. For example, it suits camera and screen recorder. Surface sources implement ISurfaceSourceInternal (such as CameraSource).

classDiagram
    class ISurfaceSourceInternal {
        <<interface>>
        +setOutput(surface: Surface)
        +getOutput() Surface
        +resetOutput()
    }

    class IVideoFrameSourceInternal {
        <<interface>>
        +getVideoFrame(buffer: ByteBuffer) RawFrame
    }

    class IVideoSource {
        <<interface>>
    }

    class IVideoSourceInternal {
        <<interface>>
        +startStream()
        +stopStream()
    }

    IVideoSourceInternal <|.. IVideoSource

    class ICameraSource {
        <<interface>>
        +settings: CameraSettings
    }

    ICameraSource <|.. IVideoSource

    class IPreviewableSource {
        <<interface>>
        +setPreview(surface: Surface)
        +resetPreview()
        +startPreview()
        +stopPreview()
        +startPreview(surface: Surface)
    }

    class CameraSource {
    }

    ISurfaceSourceInternal <|.. CameraSource
    IVideoSourceInternal <|.. CameraSource
    ICameraSource <|.. CameraSource
    IPreviewableSource <|.. CameraSource

    class IAudioFrameSourceInternal {
        <<interface>>
        +getAudioFrame(buffer: ByteBuffer) Frame
    }

    class IAudioSource {
        <<interface>>
    }
    class IAudioSourceInternal {
        <<interface>>
        +startStream()
        +stopStream()
    }
    IAudioSourceInternal <|.. IAudioFrameSourceInternal
    IAudioSourceInternal <|.. IAudioSource

    class IAudioRecordSource {
        <<interface>>
        +addEffect(effect: UUID)
        +removeEffect(effect: UUID)
    }

    class MicrophoneSource {
    }

    IAudioSourceInternal <|.. MicrophoneSource
    IAudioSource <|.. MicrophoneSource
    IAudioRecordSource <|.. MicrophoneSource

To create a new audio source, implements IAudioSourceInternal(inherits from IAudioFrameSource).

To create a new video source, implements IVideoSourceInternal and ISurfaceSourceInternal (or IVideoFrameSourceInternal - not supported). Always prefer to use a video source as a Surface source if it is possible. IVideoFrameSourceInternal is not usable in a streamer. If the video source is previewable, it must implements IPreviewableSource. You can use the AbstractPreviewableSource class to simplify the work.