Search Results for

    Show / Hide Table of Contents

    Class LocalParticipant

    Inheritance
    System.Object
    JSRef
    JSObject
    JSEventEmitter<ParticipantEvent>
    Participant
    LocalParticipant
    Inherited Members
    Participant.TrackPublished
    Participant.TrackSubscribed
    Participant.TrackSubscriptionFailed
    Participant.TrackUnpublished
    Participant.TrackUnsubscribed
    Participant.TrackMuted
    Participant.TrackUnmuted
    Participant.LocalTrackPublished
    Participant.LocalTrackUnpublished
    Participant.ParticipantMetadataChanged
    Participant.DataReceived
    Participant.IsSpeakingChanged
    Participant.ConnectionQualityChanged
    Participant.TrackStreamStateChanged
    Participant.TrackSubscriptionPermissionChanged
    Participant.AudioTrackPublications
    Participant.VideoTrackPublications
    Participant.TrackPublications
    Participant.AudioLevel
    Participant.IsSpeaking
    Participant.Sid
    Participant.Identity
    Participant.Name
    Participant.Metadata
    Participant.attributes
    Participant.LastSpokeAt
    Participant.IsCameraEnabled
    Participant.IsMicrophoneEnabled
    Participant.IsScreenShareEnabled
    Participant.GetTrackPublications()
    JSEventEmitter<ParticipantEvent>.Dispose(Boolean)
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: LiveKit
    Assembly: cs.temp.dll.dll
    Syntax
    public class LocalParticipant : Participant

    Methods

    CreateScreenTracks(Nullable<ScreenShareCaptureOptions>)

    Declaration
    public JSPromise<JSArray<LocalTrack>> CreateScreenTracks(ScreenShareCaptureOptions? options = null)
    Parameters
    Type Name Description
    System.Nullable<ScreenShareCaptureOptions> options
    Returns
    Type Description
    JSPromise<JSArray<LocalTrack>>

    CreateTracks(Nullable<CreateLocalTracksOptions>)

    Declaration
    public JSPromise<JSArray<LocalTrack>> CreateTracks(CreateLocalTracksOptions? options = null)
    Parameters
    Type Name Description
    System.Nullable<CreateLocalTracksOptions> options
    Returns
    Type Description
    JSPromise<JSArray<LocalTrack>>

    EnableCameraAndMicrophone()

    Declaration
    public JSPromise EnableCameraAndMicrophone()
    Returns
    Type Description
    JSPromise

    GetTrackPublication(TrackSource)

    Declaration
    public LocalTrackPublication GetTrackPublication(TrackSource source)
    Parameters
    Type Name Description
    TrackSource source
    Returns
    Type Description
    LocalTrackPublication

    GetTrackPublicationByName(String)

    Declaration
    public LocalTrackPublication GetTrackPublicationByName(string name)
    Parameters
    Type Name Description
    System.String name
    Returns
    Type Description
    LocalTrackPublication

    GetTrackPublicationBySid(String)

    Declaration
    public LocalTrackPublication GetTrackPublicationBySid(string sid)
    Parameters
    Type Name Description
    System.String sid
    Returns
    Type Description
    LocalTrackPublication

    LastCameraError()

    Declaration
    public JSError LastCameraError()
    Returns
    Type Description
    JSError

    LastMicrophoneError()

    Declaration
    public JSError LastMicrophoneError()
    Returns
    Type Description
    JSError

    PublishData(Byte[], Boolean, String[], String)

    Declaration
    public JSPromise PublishData(byte[] data, bool reliable, string[] destinationIdentities, string topic)
    Parameters
    Type Name Description
    System.Byte[] data
    System.Boolean reliable
    System.String[] destinationIdentities
    System.String topic
    Returns
    Type Description
    JSPromise

    PublishData(Byte[], Int32, Int32, Boolean, String[], String)

    Declaration
    public JSPromise PublishData(byte[] data, int offset, int size, bool reliable, string[] destinationIdentities, string topic)
    Parameters
    Type Name Description
    System.Byte[] data
    System.Int32 offset
    System.Int32 size
    System.Boolean reliable
    System.String[] destinationIdentities
    System.String topic
    Returns
    Type Description
    JSPromise

    PublishTrack(LocalTrack, Nullable<TrackPublishOptions>)

    Declaration
    public JSPromise<LocalTrackPublication> PublishTrack(LocalTrack track, TrackPublishOptions? options = null)
    Parameters
    Type Name Description
    LocalTrack track
    System.Nullable<TrackPublishOptions> options
    Returns
    Type Description
    JSPromise<LocalTrackPublication>

    PublishTrack(MediaStreamTrack, Nullable<TrackPublishOptions>)

    Declaration
    public JSPromise<LocalTrackPublication> PublishTrack(MediaStreamTrack track, TrackPublishOptions? options = null)
    Parameters
    Type Name Description
    MediaStreamTrack track
    System.Nullable<TrackPublishOptions> options
    Returns
    Type Description
    JSPromise<LocalTrackPublication>

    SetAttributes(JSMap<String, String>)

    Declaration
    public JSPromise SetAttributes(JSMap<string, string> attributes)
    Parameters
    Type Name Description
    JSMap<System.String, System.String> attributes
    Returns
    Type Description
    JSPromise

    SetCameraEnabled(Boolean, Nullable<VideoCaptureOptions>, Nullable<TrackPublishOptions>)

    Declaration
    public JSPromise<LocalTrackPublication> SetCameraEnabled(bool enabled, VideoCaptureOptions? options = null, TrackPublishOptions? publishOptions = null)
    Parameters
    Type Name Description
    System.Boolean enabled
    System.Nullable<VideoCaptureOptions> options
    System.Nullable<TrackPublishOptions> publishOptions
    Returns
    Type Description
    JSPromise<LocalTrackPublication>

    SetMetadata(String)

    Declaration
    public JSPromise SetMetadata(string metadata)
    Parameters
    Type Name Description
    System.String metadata
    Returns
    Type Description
    JSPromise

    SetMicrophoneEnabled(Boolean, Nullable<AudioCaptureOptions>, Nullable<TrackPublishOptions>)

    Declaration
    public JSPromise<LocalTrackPublication> SetMicrophoneEnabled(bool enabled, AudioCaptureOptions? options = null, TrackPublishOptions? publishOptions = null)
    Parameters
    Type Name Description
    System.Boolean enabled
    System.Nullable<AudioCaptureOptions> options
    System.Nullable<TrackPublishOptions> publishOptions
    Returns
    Type Description
    JSPromise<LocalTrackPublication>

    SetName(String)

    Declaration
    public JSPromise SetName(string name)
    Parameters
    Type Name Description
    System.String name
    Returns
    Type Description
    JSPromise

    SetScreenShareEnabled(Boolean, Nullable<ScreenShareCaptureOptions>, Nullable<TrackPublishOptions>)

    Declaration
    public JSPromise<LocalTrackPublication> SetScreenShareEnabled(bool enabled, ScreenShareCaptureOptions? options = null, TrackPublishOptions? publishOptions = null)
    Parameters
    Type Name Description
    System.Boolean enabled
    System.Nullable<ScreenShareCaptureOptions> options
    System.Nullable<TrackPublishOptions> publishOptions
    Returns
    Type Description
    JSPromise<LocalTrackPublication>

    SetTrackSubscriptionPermissions(Boolean, ParticipantTrackPermission[])

    Declaration
    public void SetTrackSubscriptionPermissions(bool allParticipantsAllowed, ParticipantTrackPermission[] participantTrackPermissions)
    Parameters
    Type Name Description
    System.Boolean allParticipantsAllowed
    ParticipantTrackPermission[] participantTrackPermissions

    UnpublishTrack(LocalTrack, Nullable<Boolean>)

    Declaration
    public LocalTrackPublication UnpublishTrack(LocalTrack track, bool? stopOnUnpublish = null)
    Parameters
    Type Name Description
    LocalTrack track
    System.Nullable<System.Boolean> stopOnUnpublish
    Returns
    Type Description
    LocalTrackPublication

    UnpublishTrack(MediaStreamTrack, Nullable<Boolean>)

    Declaration
    public LocalTrackPublication UnpublishTrack(MediaStreamTrack track, bool? stopOnUnpublish = null)
    Parameters
    Type Name Description
    MediaStreamTrack track
    System.Nullable<System.Boolean> stopOnUnpublish
    Returns
    Type Description
    LocalTrackPublication
    In This Article
    Back to top LiveKit Client SDK for Unity WebGL