Member Junction
    Preparing search index...

    Interface RtcNodeModule

    The subset of the @livekit/rtc-node module this wrapper constructs from. VERIFY ctor signatures.

    interface RtcNodeModule {
        AudioFrame: new (
            data: Int16Array,
            sampleRate: number,
            channels: number,
            samplesPerChannel: number,
        ) => RtcAudioFrame;
        AudioSource: new (sampleRate: number, channels: number) => RtcAudioSource;
        AudioStream: new (
            track: RtcTrack,
            sampleRate?: number,
            channels?: number,
        ) => RtcAudioStream;
        LocalAudioTrack: {
            createAudioTrack(
                name: string,
                source: RtcAudioSource,
            ): RtcLocalAudioTrack;
        };
        Room: new () => RtcRoom;
        RoomEvent: {
            Disconnected: string;
            ParticipantConnected: string;
            ParticipantDisconnected: string;
            TrackSubscribed: string;
        };
        TrackKind: { KIND_AUDIO: number };
        TrackPublishOptions: new (
            data?: {
                dtx?: boolean;
                red?: boolean;
                source?: number;
                stream?: string;
            },
        ) => RtcTrackPublishOptions;
        TrackSource: { SOURCE_MICROPHONE: number };
    }
    Index

    Properties

    AudioFrame AudioSource AudioStream LocalAudioTrack Room RoomEvent TrackKind TrackPublishOptions TrackSource

    Properties

    AudioFrame: new (
        data: Int16Array,
        sampleRate: number,
        channels: number,
        samplesPerChannel: number,
    ) => RtcAudioFrame

    new AudioFrame(data, sampleRate, channels, samplesPerChannel).

    AudioSource: new (sampleRate: number, channels: number) => RtcAudioSource

    new AudioSource(sampleRate, channels).

    AudioStream: new (
        track: RtcTrack,
        sampleRate?: number,
        channels?: number,
    ) => RtcAudioStream

    new AudioStream(track, sampleRate, channels) — resamples inbound to the requested rate.

    LocalAudioTrack: {
        createAudioTrack(
            name: string,
            source: RtcAudioSource,
        ): RtcLocalAudioTrack;
    }

    LocalAudioTrack.createAudioTrack(name, source).

    Room: new () => RtcRoom

    new Room().

    RoomEvent: {
        Disconnected: string;
        ParticipantConnected: string;
        ParticipantDisconnected: string;
        TrackSubscribed: string;
    }

    Event-name constants. VERIFY exact member names.

    TrackKind: { KIND_AUDIO: number }

    Track-kind constants. VERIFY: KIND_AUDIO.

    TrackPublishOptions: new (
        data?: {
            dtx?: boolean;
            red?: boolean;
            source?: number;
            stream?: string;
        },
    ) => RtcTrackPublishOptions

    new TrackPublishOptions({ source }) — the publish-options protobuf message. REQUIRED by publishTrack: passing a plain object leaves source unset and the track improperly bound, so the native AudioSource.captureFrame rejects every frame with InvalidState. Construct the real proto.

    TrackSource: { SOURCE_MICROPHONE: number }

    Track-source constants — SOURCE_MICROPHONE tags the bot's published voice track.

    Settings

    Member Visibility

    On This Page

    Properties