Documentation
¶
Index ¶
- Constants
- Variables
- func WriteError(resp http.ResponseWriter, err error)
- type ActiveSpeakerUpdate
- func (*ActiveSpeakerUpdate) Descriptor() ([]byte, []int)deprecated
- func (x *ActiveSpeakerUpdate) GetSpeakers() []*SpeakerInfo
- func (*ActiveSpeakerUpdate) ProtoMessage()
- func (x *ActiveSpeakerUpdate) ProtoReflect() protoreflect.Message
- func (x *ActiveSpeakerUpdate) Reset()
- func (x *ActiveSpeakerUpdate) String() string
- type AddTrackRequest
- func (*AddTrackRequest) Descriptor() ([]byte, []int)deprecated
- func (x *AddTrackRequest) GetCid() string
- func (x *AddTrackRequest) GetHeight() uint32
- func (x *AddTrackRequest) GetName() string
- func (x *AddTrackRequest) GetType() TrackType
- func (x *AddTrackRequest) GetWidth() uint32
- func (*AddTrackRequest) ProtoMessage()
- func (x *AddTrackRequest) ProtoReflect() protoreflect.Message
- func (x *AddTrackRequest) Reset()
- func (x *AddTrackRequest) String() string
- type Codec
- type CreateRoomRequest
- func (*CreateRoomRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateRoomRequest) GetEmptyTimeout() uint32
- func (x *CreateRoomRequest) GetMaxParticipants() uint32
- func (x *CreateRoomRequest) GetName() string
- func (x *CreateRoomRequest) GetNodeId() string
- func (*CreateRoomRequest) ProtoMessage()
- func (x *CreateRoomRequest) ProtoReflect() protoreflect.Message
- func (x *CreateRoomRequest) Reset()
- func (x *CreateRoomRequest) String() string
- type DataMessage
- func (*DataMessage) Descriptor() ([]byte, []int)deprecated
- func (x *DataMessage) GetBinary() []byte
- func (x *DataMessage) GetText() string
- func (m *DataMessage) GetValue() isDataMessage_Value
- func (*DataMessage) ProtoMessage()
- func (x *DataMessage) ProtoReflect() protoreflect.Message
- func (x *DataMessage) Reset()
- func (x *DataMessage) String() string
- type DataMessage_Binary
- type DataMessage_Text
- type DataPacket
- func (*DataPacket) Descriptor() ([]byte, []int)deprecated
- func (x *DataPacket) GetKind() DataPacket_Kind
- func (x *DataPacket) GetSpeaker() *ActiveSpeakerUpdate
- func (x *DataPacket) GetUser() *UserPacket
- func (m *DataPacket) GetValue() isDataPacket_Value
- func (*DataPacket) ProtoMessage()
- func (x *DataPacket) ProtoReflect() protoreflect.Message
- func (x *DataPacket) Reset()
- func (x *DataPacket) String() string
- type DataPacket_Kind
- func (DataPacket_Kind) Descriptor() protoreflect.EnumDescriptor
- func (x DataPacket_Kind) Enum() *DataPacket_Kind
- func (DataPacket_Kind) EnumDescriptor() ([]byte, []int)deprecated
- func (x DataPacket_Kind) Number() protoreflect.EnumNumber
- func (x DataPacket_Kind) String() string
- func (DataPacket_Kind) Type() protoreflect.EnumType
- type DataPacket_Speaker
- type DataPacket_User
- type DeleteRoomRequest
- type DeleteRoomResponse
- type EndRecordingRequest
- func (*EndRecordingRequest) Descriptor() ([]byte, []int)deprecated
- func (x *EndRecordingRequest) GetRecordingId() string
- func (*EndRecordingRequest) ProtoMessage()
- func (x *EndRecordingRequest) ProtoReflect() protoreflect.Message
- func (x *EndRecordingRequest) Reset()
- func (x *EndRecordingRequest) String() string
- type HTTPClient
- type ICEServer
- func (*ICEServer) Descriptor() ([]byte, []int)deprecated
- func (x *ICEServer) GetCredential() string
- func (x *ICEServer) GetUrls() []string
- func (x *ICEServer) GetUsername() string
- func (*ICEServer) ProtoMessage()
- func (x *ICEServer) ProtoReflect() protoreflect.Message
- func (x *ICEServer) Reset()
- func (x *ICEServer) String() string
- type JoinResponse
- func (*JoinResponse) Descriptor() ([]byte, []int)deprecated
- func (x *JoinResponse) GetIceServers() []*ICEServer
- func (x *JoinResponse) GetOtherParticipants() []*ParticipantInfo
- func (x *JoinResponse) GetParticipant() *ParticipantInfo
- func (x *JoinResponse) GetRoom() *Room
- func (x *JoinResponse) GetServerVersion() string
- func (*JoinResponse) ProtoMessage()
- func (x *JoinResponse) ProtoReflect() protoreflect.Message
- func (x *JoinResponse) Reset()
- func (x *JoinResponse) String() string
- type LeaveRequest
- type ListParticipantsRequest
- func (*ListParticipantsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListParticipantsRequest) GetRoom() string
- func (*ListParticipantsRequest) ProtoMessage()
- func (x *ListParticipantsRequest) ProtoReflect() protoreflect.Message
- func (x *ListParticipantsRequest) Reset()
- func (x *ListParticipantsRequest) String() string
- type ListParticipantsResponse
- func (*ListParticipantsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListParticipantsResponse) GetParticipants() []*ParticipantInfo
- func (*ListParticipantsResponse) ProtoMessage()
- func (x *ListParticipantsResponse) ProtoReflect() protoreflect.Message
- func (x *ListParticipantsResponse) Reset()
- func (x *ListParticipantsResponse) String() string
- type ListRoomsRequest
- type ListRoomsResponse
- type MuteRoomTrackRequest
- func (*MuteRoomTrackRequest) Descriptor() ([]byte, []int)deprecated
- func (x *MuteRoomTrackRequest) GetIdentity() string
- func (x *MuteRoomTrackRequest) GetMuted() bool
- func (x *MuteRoomTrackRequest) GetRoom() string
- func (x *MuteRoomTrackRequest) GetTrackSid() string
- func (*MuteRoomTrackRequest) ProtoMessage()
- func (x *MuteRoomTrackRequest) ProtoReflect() protoreflect.Message
- func (x *MuteRoomTrackRequest) Reset()
- func (x *MuteRoomTrackRequest) String() string
- type MuteRoomTrackResponse
- func (*MuteRoomTrackResponse) Descriptor() ([]byte, []int)deprecated
- func (x *MuteRoomTrackResponse) GetTrack() *TrackInfo
- func (*MuteRoomTrackResponse) ProtoMessage()
- func (x *MuteRoomTrackResponse) ProtoReflect() protoreflect.Message
- func (x *MuteRoomTrackResponse) Reset()
- func (x *MuteRoomTrackResponse) String() string
- type MuteTrackRequest
- func (*MuteTrackRequest) Descriptor() ([]byte, []int)deprecated
- func (x *MuteTrackRequest) GetMuted() bool
- func (x *MuteTrackRequest) GetSid() string
- func (*MuteTrackRequest) ProtoMessage()
- func (x *MuteTrackRequest) ProtoReflect() protoreflect.Message
- func (x *MuteTrackRequest) Reset()
- func (x *MuteTrackRequest) String() string
- type ParticipantInfo
- func (*ParticipantInfo) Descriptor() ([]byte, []int)deprecated
- func (x *ParticipantInfo) GetHidden() bool
- func (x *ParticipantInfo) GetIdentity() string
- func (x *ParticipantInfo) GetJoinedAt() int64
- func (x *ParticipantInfo) GetMetadata() string
- func (x *ParticipantInfo) GetSid() string
- func (x *ParticipantInfo) GetState() ParticipantInfo_State
- func (x *ParticipantInfo) GetTracks() []*TrackInfo
- func (*ParticipantInfo) ProtoMessage()
- func (x *ParticipantInfo) ProtoReflect() protoreflect.Message
- func (x *ParticipantInfo) Reset()
- func (x *ParticipantInfo) String() string
- type ParticipantInfo_State
- func (ParticipantInfo_State) Descriptor() protoreflect.EnumDescriptor
- func (x ParticipantInfo_State) Enum() *ParticipantInfo_State
- func (ParticipantInfo_State) EnumDescriptor() ([]byte, []int)deprecated
- func (x ParticipantInfo_State) Number() protoreflect.EnumNumber
- func (x ParticipantInfo_State) String() string
- func (ParticipantInfo_State) Type() protoreflect.EnumType
- type ParticipantPermission
- func (*ParticipantPermission) Descriptor() ([]byte, []int)deprecated
- func (x *ParticipantPermission) GetCanPublish() bool
- func (x *ParticipantPermission) GetCanSubscribe() bool
- func (*ParticipantPermission) ProtoMessage()
- func (x *ParticipantPermission) ProtoReflect() protoreflect.Message
- func (x *ParticipantPermission) Reset()
- func (x *ParticipantPermission) String() string
- type ParticipantUpdate
- func (*ParticipantUpdate) Descriptor() ([]byte, []int)deprecated
- func (x *ParticipantUpdate) GetParticipants() []*ParticipantInfo
- func (*ParticipantUpdate) ProtoMessage()
- func (x *ParticipantUpdate) ProtoReflect() protoreflect.Message
- func (x *ParticipantUpdate) Reset()
- func (x *ParticipantUpdate) String() string
- type RecordingOptions
- func (*RecordingOptions) Descriptor() ([]byte, []int)deprecated
- func (x *RecordingOptions) GetAudioBitrate() int32
- func (x *RecordingOptions) GetAudioFrequency() int32
- func (x *RecordingOptions) GetDepth() int32
- func (x *RecordingOptions) GetFramerate() int32
- func (x *RecordingOptions) GetInputHeight() int32
- func (x *RecordingOptions) GetInputWidth() int32
- func (x *RecordingOptions) GetOutputHeight() int32
- func (x *RecordingOptions) GetOutputWidth() int32
- func (x *RecordingOptions) GetPreset() string
- func (x *RecordingOptions) GetVideoBitrate() int32
- func (*RecordingOptions) ProtoMessage()
- func (x *RecordingOptions) ProtoReflect() protoreflect.Message
- func (x *RecordingOptions) Reset()
- func (x *RecordingOptions) String() string
- type RecordingResponse
- func (*RecordingResponse) Descriptor() ([]byte, []int)deprecated
- func (x *RecordingResponse) GetRecordingId() string
- func (*RecordingResponse) ProtoMessage()
- func (x *RecordingResponse) ProtoReflect() protoreflect.Message
- func (x *RecordingResponse) Reset()
- func (x *RecordingResponse) String() string
- type RecordingS3Output
- func (*RecordingS3Output) Descriptor() ([]byte, []int)deprecated
- func (x *RecordingS3Output) GetAccessKey() string
- func (x *RecordingS3Output) GetBucket() string
- func (x *RecordingS3Output) GetKey() string
- func (x *RecordingS3Output) GetSecret() string
- func (*RecordingS3Output) ProtoMessage()
- func (x *RecordingS3Output) ProtoReflect() protoreflect.Message
- func (x *RecordingS3Output) Reset()
- func (x *RecordingS3Output) String() string
- type RecordingService
- type RecordingTemplate
- func (*RecordingTemplate) Descriptor() ([]byte, []int)deprecated
- func (x *RecordingTemplate) GetLayout() string
- func (x *RecordingTemplate) GetRoomName() string
- func (x *RecordingTemplate) GetToken() string
- func (x *RecordingTemplate) GetWsUrl() string
- func (*RecordingTemplate) ProtoMessage()
- func (x *RecordingTemplate) ProtoReflect() protoreflect.Message
- func (x *RecordingTemplate) Reset()
- func (x *RecordingTemplate) String() string
- type RemoveParticipantResponse
- type Room
- func (*Room) Descriptor() ([]byte, []int)deprecated
- func (x *Room) GetCreationTime() int64
- func (x *Room) GetEmptyTimeout() uint32
- func (x *Room) GetEnabledCodecs() []*Codec
- func (x *Room) GetMaxParticipants() uint32
- func (x *Room) GetName() string
- func (x *Room) GetSid() string
- func (x *Room) GetTurnPassword() string
- func (*Room) ProtoMessage()
- func (x *Room) ProtoReflect() protoreflect.Message
- func (x *Room) Reset()
- func (x *Room) String() string
- type RoomParticipantIdentity
- func (*RoomParticipantIdentity) Descriptor() ([]byte, []int)deprecated
- func (x *RoomParticipantIdentity) GetIdentity() string
- func (x *RoomParticipantIdentity) GetRoom() string
- func (*RoomParticipantIdentity) ProtoMessage()
- func (x *RoomParticipantIdentity) ProtoReflect() protoreflect.Message
- func (x *RoomParticipantIdentity) Reset()
- func (x *RoomParticipantIdentity) String() string
- type RoomService
- type SessionDescription
- func (*SessionDescription) Descriptor() ([]byte, []int)deprecated
- func (x *SessionDescription) GetSdp() string
- func (x *SessionDescription) GetType() string
- func (*SessionDescription) ProtoMessage()
- func (x *SessionDescription) ProtoReflect() protoreflect.Message
- func (x *SessionDescription) Reset()
- func (x *SessionDescription) String() string
- type SetSimulcastLayers
- func (*SetSimulcastLayers) Descriptor() ([]byte, []int)deprecated
- func (x *SetSimulcastLayers) GetLayers() []VideoQuality
- func (x *SetSimulcastLayers) GetTrackSid() string
- func (*SetSimulcastLayers) ProtoMessage()
- func (x *SetSimulcastLayers) ProtoReflect() protoreflect.Message
- func (x *SetSimulcastLayers) Reset()
- func (x *SetSimulcastLayers) String() string
- type SignalRequest
- func (*SignalRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SignalRequest) GetAddTrack() *AddTrackRequest
- func (x *SignalRequest) GetAnswer() *SessionDescription
- func (x *SignalRequest) GetLeave() *LeaveRequest
- func (m *SignalRequest) GetMessage() isSignalRequest_Message
- func (x *SignalRequest) GetMute() *MuteTrackRequest
- func (x *SignalRequest) GetOffer() *SessionDescription
- func (x *SignalRequest) GetSimulcast() *SetSimulcastLayers
- func (x *SignalRequest) GetSubscription() *UpdateSubscription
- func (x *SignalRequest) GetTrackSetting() *UpdateTrackSettings
- func (x *SignalRequest) GetTrickle() *TrickleRequest
- func (*SignalRequest) ProtoMessage()
- func (x *SignalRequest) ProtoReflect() protoreflect.Message
- func (x *SignalRequest) Reset()
- func (x *SignalRequest) String() string
- type SignalRequest_AddTrack
- type SignalRequest_Answer
- type SignalRequest_Leave
- type SignalRequest_Mute
- type SignalRequest_Offer
- type SignalRequest_Simulcast
- type SignalRequest_Subscription
- type SignalRequest_TrackSetting
- type SignalRequest_Trickle
- type SignalResponse
- func (*SignalResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SignalResponse) GetAnswer() *SessionDescription
- func (x *SignalResponse) GetJoin() *JoinResponse
- func (x *SignalResponse) GetLeave() *LeaveRequest
- func (m *SignalResponse) GetMessage() isSignalResponse_Message
- func (x *SignalResponse) GetOffer() *SessionDescription
- func (x *SignalResponse) GetSpeaker() *ActiveSpeakerUpdate
- func (x *SignalResponse) GetTrackPublished() *TrackPublishedResponse
- func (x *SignalResponse) GetTrickle() *TrickleRequest
- func (x *SignalResponse) GetUpdate() *ParticipantUpdate
- func (*SignalResponse) ProtoMessage()
- func (x *SignalResponse) ProtoReflect() protoreflect.Message
- func (x *SignalResponse) Reset()
- func (x *SignalResponse) String() string
- type SignalResponse_Answer
- type SignalResponse_Join
- type SignalResponse_Leave
- type SignalResponse_Offer
- type SignalResponse_Speaker
- type SignalResponse_TrackPublished
- type SignalResponse_Trickle
- type SignalResponse_Update
- type SignalTarget
- func (SignalTarget) Descriptor() protoreflect.EnumDescriptor
- func (x SignalTarget) Enum() *SignalTarget
- func (SignalTarget) EnumDescriptor() ([]byte, []int)deprecated
- func (x SignalTarget) Number() protoreflect.EnumNumber
- func (x SignalTarget) String() string
- func (SignalTarget) Type() protoreflect.EnumType
- type SpeakerInfo
- func (*SpeakerInfo) Descriptor() ([]byte, []int)deprecated
- func (x *SpeakerInfo) GetActive() bool
- func (x *SpeakerInfo) GetLevel() float32
- func (x *SpeakerInfo) GetSid() string
- func (*SpeakerInfo) ProtoMessage()
- func (x *SpeakerInfo) ProtoReflect() protoreflect.Message
- func (x *SpeakerInfo) Reset()
- func (x *SpeakerInfo) String() string
- type StartRecordingRequest
- func (*StartRecordingRequest) Descriptor() ([]byte, []int)deprecated
- func (x *StartRecordingRequest) GetFile() string
- func (m *StartRecordingRequest) GetInput() isStartRecordingRequest_Input
- func (x *StartRecordingRequest) GetOptions() *RecordingOptions
- func (m *StartRecordingRequest) GetOutput() isStartRecordingRequest_Output
- func (x *StartRecordingRequest) GetRtmp() string
- func (x *StartRecordingRequest) GetS3() *RecordingS3Output
- func (x *StartRecordingRequest) GetTemplate() *RecordingTemplate
- func (x *StartRecordingRequest) GetUrl() string
- func (*StartRecordingRequest) ProtoMessage()
- func (x *StartRecordingRequest) ProtoReflect() protoreflect.Message
- func (x *StartRecordingRequest) Reset()
- func (x *StartRecordingRequest) String() string
- type StartRecordingRequest_File
- type StartRecordingRequest_Rtmp
- type StartRecordingRequest_S3
- type StartRecordingRequest_Template
- type StartRecordingRequest_Url
- type TrackInfo
- func (*TrackInfo) Descriptor() ([]byte, []int)deprecated
- func (x *TrackInfo) GetHeight() uint32
- func (x *TrackInfo) GetMuted() bool
- func (x *TrackInfo) GetName() string
- func (x *TrackInfo) GetSid() string
- func (x *TrackInfo) GetSimulcast() bool
- func (x *TrackInfo) GetType() TrackType
- func (x *TrackInfo) GetWidth() uint32
- func (*TrackInfo) ProtoMessage()
- func (x *TrackInfo) ProtoReflect() protoreflect.Message
- func (x *TrackInfo) Reset()
- func (x *TrackInfo) String() string
- type TrackPublishedResponse
- func (*TrackPublishedResponse) Descriptor() ([]byte, []int)deprecated
- func (x *TrackPublishedResponse) GetCid() string
- func (x *TrackPublishedResponse) GetTrack() *TrackInfo
- func (*TrackPublishedResponse) ProtoMessage()
- func (x *TrackPublishedResponse) ProtoReflect() protoreflect.Message
- func (x *TrackPublishedResponse) Reset()
- func (x *TrackPublishedResponse) String() string
- type TrackType
- type TrickleRequest
- func (*TrickleRequest) Descriptor() ([]byte, []int)deprecated
- func (x *TrickleRequest) GetCandidateInit() string
- func (x *TrickleRequest) GetTarget() SignalTarget
- func (*TrickleRequest) ProtoMessage()
- func (x *TrickleRequest) ProtoReflect() protoreflect.Message
- func (x *TrickleRequest) Reset()
- func (x *TrickleRequest) String() string
- type TwirpServer
- type UpdateParticipantRequest
- func (*UpdateParticipantRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateParticipantRequest) GetIdentity() string
- func (x *UpdateParticipantRequest) GetMetadata() string
- func (x *UpdateParticipantRequest) GetPermission() *ParticipantPermission
- func (x *UpdateParticipantRequest) GetRoom() string
- func (*UpdateParticipantRequest) ProtoMessage()
- func (x *UpdateParticipantRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateParticipantRequest) Reset()
- func (x *UpdateParticipantRequest) String() string
- type UpdateSubscription
- func (*UpdateSubscription) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateSubscription) GetSubscribe() bool
- func (x *UpdateSubscription) GetTrackSids() []string
- func (*UpdateSubscription) ProtoMessage()
- func (x *UpdateSubscription) ProtoReflect() protoreflect.Message
- func (x *UpdateSubscription) Reset()
- func (x *UpdateSubscription) String() string
- type UpdateSubscriptionsRequest
- func (*UpdateSubscriptionsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateSubscriptionsRequest) GetIdentity() string
- func (x *UpdateSubscriptionsRequest) GetRoom() string
- func (x *UpdateSubscriptionsRequest) GetSubscribe() bool
- func (x *UpdateSubscriptionsRequest) GetTrackSids() []string
- func (*UpdateSubscriptionsRequest) ProtoMessage()
- func (x *UpdateSubscriptionsRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateSubscriptionsRequest) Reset()
- func (x *UpdateSubscriptionsRequest) String() string
- type UpdateSubscriptionsResponse
- type UpdateTrackSettings
- func (*UpdateTrackSettings) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateTrackSettings) GetDisabled() bool
- func (x *UpdateTrackSettings) GetQuality() VideoQuality
- func (x *UpdateTrackSettings) GetTrackSids() []string
- func (*UpdateTrackSettings) ProtoMessage()
- func (x *UpdateTrackSettings) ProtoReflect() protoreflect.Message
- func (x *UpdateTrackSettings) Reset()
- func (x *UpdateTrackSettings) String() string
- type UserPacket
- func (*UserPacket) Descriptor() ([]byte, []int)deprecated
- func (x *UserPacket) GetDestinationSids() []string
- func (x *UserPacket) GetParticipantSid() string
- func (x *UserPacket) GetPayload() []byte
- func (*UserPacket) ProtoMessage()
- func (x *UserPacket) ProtoReflect() protoreflect.Message
- func (x *UserPacket) Reset()
- func (x *UserPacket) String() string
- type VideoQuality
- func (VideoQuality) Descriptor() protoreflect.EnumDescriptor
- func (x VideoQuality) Enum() *VideoQuality
- func (VideoQuality) EnumDescriptor() ([]byte, []int)deprecated
- func (x VideoQuality) Number() protoreflect.EnumNumber
- func (x VideoQuality) String() string
- func (VideoQuality) Type() protoreflect.EnumType
Constants ¶
const RecordingServicePathPrefix = "/twirp/livekit.RecordingService/"
RecordingServicePathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html
const RoomServicePathPrefix = "/twirp/livekit.RoomService/"
RoomServicePathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html
Variables ¶
var ( TrackType_name = map[int32]string{ 0: "AUDIO", 1: "VIDEO", 2: "DATA", } TrackType_value = map[string]int32{ "AUDIO": 0, "VIDEO": 1, "DATA": 2, } )
Enum value maps for TrackType.
var ( ParticipantInfo_State_name = map[int32]string{ 0: "JOINING", 1: "JOINED", 2: "ACTIVE", 3: "DISCONNECTED", } ParticipantInfo_State_value = map[string]int32{ "JOINING": 0, "JOINED": 1, "ACTIVE": 2, "DISCONNECTED": 3, } )
Enum value maps for ParticipantInfo_State.
var ( SignalTarget_name = map[int32]string{ 0: "PUBLISHER", 1: "SUBSCRIBER", } SignalTarget_value = map[string]int32{ "PUBLISHER": 0, "SUBSCRIBER": 1, } )
Enum value maps for SignalTarget.
var ( VideoQuality_name = map[int32]string{ 0: "LOW", 1: "MEDIUM", 2: "HIGH", } VideoQuality_value = map[string]int32{ "LOW": 0, "MEDIUM": 1, "HIGH": 2, } )
Enum value maps for VideoQuality.
var ( DataPacket_Kind_name = map[int32]string{ 0: "RELIABLE", 1: "LOSSY", } DataPacket_Kind_value = map[string]int32{ "RELIABLE": 0, "LOSSY": 1, } )
Enum value maps for DataPacket_Kind.
var File_livekit_models_proto protoreflect.FileDescriptor
var File_livekit_recording_proto protoreflect.FileDescriptor
var File_livekit_room_proto protoreflect.FileDescriptor
var File_livekit_rtc_proto protoreflect.FileDescriptor
Functions ¶
func WriteError ¶
func WriteError(resp http.ResponseWriter, err error)
WriteError writes an HTTP response with a valid Twirp error format (code, msg, meta). Useful outside of the Twirp server (e.g. http middleware), but does not trigger hooks. If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err)
Types ¶
type ActiveSpeakerUpdate ¶
type ActiveSpeakerUpdate struct {
Speakers []*SpeakerInfo `protobuf:"bytes,1,rep,name=speakers,proto3" json:"speakers,omitempty"`
// contains filtered or unexported fields
}
func (*ActiveSpeakerUpdate) Descriptor
deprecated
func (*ActiveSpeakerUpdate) Descriptor() ([]byte, []int)
Deprecated: Use ActiveSpeakerUpdate.ProtoReflect.Descriptor instead.
func (*ActiveSpeakerUpdate) GetSpeakers ¶
func (x *ActiveSpeakerUpdate) GetSpeakers() []*SpeakerInfo
func (*ActiveSpeakerUpdate) ProtoMessage ¶
func (*ActiveSpeakerUpdate) ProtoMessage()
func (*ActiveSpeakerUpdate) ProtoReflect ¶
func (x *ActiveSpeakerUpdate) ProtoReflect() protoreflect.Message
func (*ActiveSpeakerUpdate) Reset ¶
func (x *ActiveSpeakerUpdate) Reset()
func (*ActiveSpeakerUpdate) String ¶
func (x *ActiveSpeakerUpdate) String() string
type AddTrackRequest ¶
type AddTrackRequest struct {
// client ID of track, to match it when RTC track is received
Cid string `protobuf:"bytes,1,opt,name=cid,proto3" json:"cid,omitempty"`
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
Type TrackType `protobuf:"varint,3,opt,name=type,proto3,enum=livekit.TrackType" json:"type,omitempty"`
Width uint32 `protobuf:"varint,4,opt,name=width,proto3" json:"width,omitempty"`
Height uint32 `protobuf:"varint,5,opt,name=height,proto3" json:"height,omitempty"`
// contains filtered or unexported fields
}
func (*AddTrackRequest) Descriptor
deprecated
func (*AddTrackRequest) Descriptor() ([]byte, []int)
Deprecated: Use AddTrackRequest.ProtoReflect.Descriptor instead.
func (*AddTrackRequest) GetCid ¶
func (x *AddTrackRequest) GetCid() string
func (*AddTrackRequest) GetHeight ¶
func (x *AddTrackRequest) GetHeight() uint32
func (*AddTrackRequest) GetName ¶
func (x *AddTrackRequest) GetName() string
func (*AddTrackRequest) GetType ¶
func (x *AddTrackRequest) GetType() TrackType
func (*AddTrackRequest) GetWidth ¶
func (x *AddTrackRequest) GetWidth() uint32
func (*AddTrackRequest) ProtoMessage ¶
func (*AddTrackRequest) ProtoMessage()
func (*AddTrackRequest) ProtoReflect ¶
func (x *AddTrackRequest) ProtoReflect() protoreflect.Message
func (*AddTrackRequest) Reset ¶
func (x *AddTrackRequest) Reset()
func (*AddTrackRequest) String ¶
func (x *AddTrackRequest) String() string
type Codec ¶ added in v0.5.11
type Codec struct {
Mime string `protobuf:"bytes,1,opt,name=mime,proto3" json:"mime,omitempty"`
FmtpLine string `protobuf:"bytes,2,opt,name=fmtp_line,json=fmtpLine,proto3" json:"fmtp_line,omitempty"`
// contains filtered or unexported fields
}
func (*Codec) Descriptor
deprecated
added in
v0.5.11
func (*Codec) GetFmtpLine ¶ added in v0.5.11
func (*Codec) ProtoMessage ¶ added in v0.5.11
func (*Codec) ProtoMessage()
func (*Codec) ProtoReflect ¶ added in v0.5.11
func (x *Codec) ProtoReflect() protoreflect.Message
type CreateRoomRequest ¶
type CreateRoomRequest struct {
// name of the room
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// number of seconds to keep the room open if no one joins
EmptyTimeout uint32 `protobuf:"varint,2,opt,name=empty_timeout,json=emptyTimeout,proto3" json:"empty_timeout,omitempty"`
// limit number of participants that can be in a room
MaxParticipants uint32 `protobuf:"varint,3,opt,name=max_participants,json=maxParticipants,proto3" json:"max_participants,omitempty"`
// override the node room is allocated to, for debugging
NodeId string `protobuf:"bytes,4,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
// contains filtered or unexported fields
}
func (*CreateRoomRequest) Descriptor
deprecated
func (*CreateRoomRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateRoomRequest.ProtoReflect.Descriptor instead.
func (*CreateRoomRequest) GetEmptyTimeout ¶
func (x *CreateRoomRequest) GetEmptyTimeout() uint32
func (*CreateRoomRequest) GetMaxParticipants ¶
func (x *CreateRoomRequest) GetMaxParticipants() uint32
func (*CreateRoomRequest) GetName ¶
func (x *CreateRoomRequest) GetName() string
func (*CreateRoomRequest) GetNodeId ¶
func (x *CreateRoomRequest) GetNodeId() string
func (*CreateRoomRequest) ProtoMessage ¶
func (*CreateRoomRequest) ProtoMessage()
func (*CreateRoomRequest) ProtoReflect ¶
func (x *CreateRoomRequest) ProtoReflect() protoreflect.Message
func (*CreateRoomRequest) Reset ¶
func (x *CreateRoomRequest) Reset()
func (*CreateRoomRequest) String ¶
func (x *CreateRoomRequest) String() string
type DataMessage ¶
type DataMessage struct {
// Types that are assignable to Value:
// *DataMessage_Text
// *DataMessage_Binary
Value isDataMessage_Value `protobuf_oneof:"value"`
// contains filtered or unexported fields
}
old DataTrack message
func (*DataMessage) Descriptor
deprecated
func (*DataMessage) Descriptor() ([]byte, []int)
Deprecated: Use DataMessage.ProtoReflect.Descriptor instead.
func (*DataMessage) GetBinary ¶
func (x *DataMessage) GetBinary() []byte
func (*DataMessage) GetText ¶
func (x *DataMessage) GetText() string
func (*DataMessage) GetValue ¶
func (m *DataMessage) GetValue() isDataMessage_Value
func (*DataMessage) ProtoMessage ¶
func (*DataMessage) ProtoMessage()
func (*DataMessage) ProtoReflect ¶
func (x *DataMessage) ProtoReflect() protoreflect.Message
func (*DataMessage) Reset ¶
func (x *DataMessage) Reset()
func (*DataMessage) String ¶
func (x *DataMessage) String() string
type DataMessage_Binary ¶
type DataMessage_Binary struct {
Binary []byte `protobuf:"bytes,2,opt,name=binary,proto3,oneof"`
}
type DataMessage_Text ¶
type DataMessage_Text struct {
Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}
type DataPacket ¶
type DataPacket struct {
Kind DataPacket_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=livekit.DataPacket_Kind" json:"kind,omitempty"`
// Types that are assignable to Value:
// *DataPacket_User
// *DataPacket_Speaker
Value isDataPacket_Value `protobuf_oneof:"value"`
// contains filtered or unexported fields
}
new DataPacket API
func (*DataPacket) Descriptor
deprecated
func (*DataPacket) Descriptor() ([]byte, []int)
Deprecated: Use DataPacket.ProtoReflect.Descriptor instead.
func (*DataPacket) GetKind ¶
func (x *DataPacket) GetKind() DataPacket_Kind
func (*DataPacket) GetSpeaker ¶
func (x *DataPacket) GetSpeaker() *ActiveSpeakerUpdate
func (*DataPacket) GetUser ¶
func (x *DataPacket) GetUser() *UserPacket
func (*DataPacket) GetValue ¶
func (m *DataPacket) GetValue() isDataPacket_Value
func (*DataPacket) ProtoMessage ¶
func (*DataPacket) ProtoMessage()
func (*DataPacket) ProtoReflect ¶
func (x *DataPacket) ProtoReflect() protoreflect.Message
func (*DataPacket) Reset ¶
func (x *DataPacket) Reset()
func (*DataPacket) String ¶
func (x *DataPacket) String() string
type DataPacket_Kind ¶
type DataPacket_Kind int32
const ( DataPacket_RELIABLE DataPacket_Kind = 0 DataPacket_LOSSY DataPacket_Kind = 1 )
func (DataPacket_Kind) Descriptor ¶
func (DataPacket_Kind) Descriptor() protoreflect.EnumDescriptor
func (DataPacket_Kind) Enum ¶
func (x DataPacket_Kind) Enum() *DataPacket_Kind
func (DataPacket_Kind) EnumDescriptor
deprecated
func (DataPacket_Kind) EnumDescriptor() ([]byte, []int)
Deprecated: Use DataPacket_Kind.Descriptor instead.
func (DataPacket_Kind) Number ¶
func (x DataPacket_Kind) Number() protoreflect.EnumNumber
func (DataPacket_Kind) String ¶
func (x DataPacket_Kind) String() string
func (DataPacket_Kind) Type ¶
func (DataPacket_Kind) Type() protoreflect.EnumType
type DataPacket_Speaker ¶
type DataPacket_Speaker struct {
Speaker *ActiveSpeakerUpdate `protobuf:"bytes,3,opt,name=speaker,proto3,oneof"`
}
type DataPacket_User ¶
type DataPacket_User struct {
User *UserPacket `protobuf:"bytes,2,opt,name=user,proto3,oneof"`
}
type DeleteRoomRequest ¶
type DeleteRoomRequest struct {
// name of the room
Room string `protobuf:"bytes,1,opt,name=room,proto3" json:"room,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteRoomRequest) Descriptor
deprecated
func (*DeleteRoomRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteRoomRequest.ProtoReflect.Descriptor instead.
func (*DeleteRoomRequest) GetRoom ¶
func (x *DeleteRoomRequest) GetRoom() string
func (*DeleteRoomRequest) ProtoMessage ¶
func (*DeleteRoomRequest) ProtoMessage()
func (*DeleteRoomRequest) ProtoReflect ¶
func (x *DeleteRoomRequest) ProtoReflect() protoreflect.Message
func (*DeleteRoomRequest) Reset ¶
func (x *DeleteRoomRequest) Reset()
func (*DeleteRoomRequest) String ¶
func (x *DeleteRoomRequest) String() string
type DeleteRoomResponse ¶
type DeleteRoomResponse struct {
// contains filtered or unexported fields
}
func (*DeleteRoomResponse) Descriptor
deprecated
func (*DeleteRoomResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteRoomResponse.ProtoReflect.Descriptor instead.
func (*DeleteRoomResponse) ProtoMessage ¶
func (*DeleteRoomResponse) ProtoMessage()
func (*DeleteRoomResponse) ProtoReflect ¶
func (x *DeleteRoomResponse) ProtoReflect() protoreflect.Message
func (*DeleteRoomResponse) Reset ¶
func (x *DeleteRoomResponse) Reset()
func (*DeleteRoomResponse) String ¶
func (x *DeleteRoomResponse) String() string
type EndRecordingRequest ¶ added in v0.6.1
type EndRecordingRequest struct {
RecordingId string `protobuf:"bytes,1,opt,name=recording_id,json=recordingId,proto3" json:"recording_id,omitempty"`
// contains filtered or unexported fields
}
func (*EndRecordingRequest) Descriptor
deprecated
added in
v0.6.1
func (*EndRecordingRequest) Descriptor() ([]byte, []int)
Deprecated: Use EndRecordingRequest.ProtoReflect.Descriptor instead.
func (*EndRecordingRequest) GetRecordingId ¶ added in v0.6.1
func (x *EndRecordingRequest) GetRecordingId() string
func (*EndRecordingRequest) ProtoMessage ¶ added in v0.6.1
func (*EndRecordingRequest) ProtoMessage()
func (*EndRecordingRequest) ProtoReflect ¶ added in v0.6.1
func (x *EndRecordingRequest) ProtoReflect() protoreflect.Message
func (*EndRecordingRequest) Reset ¶ added in v0.6.1
func (x *EndRecordingRequest) Reset()
func (*EndRecordingRequest) String ¶ added in v0.6.1
func (x *EndRecordingRequest) String() string
type HTTPClient ¶
HTTPClient is the interface used by generated clients to send HTTP requests. It is fulfilled by *(net/http).Client, which is sufficient for most users. Users can provide their own implementation for special retry policies.
HTTPClient implementations should not follow redirects. Redirects are automatically disabled if *(net/http).Client is passed to client constructors. See the withoutRedirects function in this file for more details.
type ICEServer ¶
type ICEServer struct {
Urls []string `protobuf:"bytes,1,rep,name=urls,proto3" json:"urls,omitempty"`
Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
Credential string `protobuf:"bytes,3,opt,name=credential,proto3" json:"credential,omitempty"`
// contains filtered or unexported fields
}
func (*ICEServer) Descriptor
deprecated
func (*ICEServer) GetCredential ¶
func (*ICEServer) GetUsername ¶
func (*ICEServer) ProtoMessage ¶
func (*ICEServer) ProtoMessage()
func (*ICEServer) ProtoReflect ¶
func (x *ICEServer) ProtoReflect() protoreflect.Message
type JoinResponse ¶
type JoinResponse struct {
Room *Room `protobuf:"bytes,1,opt,name=room,proto3" json:"room,omitempty"`
Participant *ParticipantInfo `protobuf:"bytes,2,opt,name=participant,proto3" json:"participant,omitempty"`
OtherParticipants []*ParticipantInfo `protobuf:"bytes,3,rep,name=other_participants,json=otherParticipants,proto3" json:"other_participants,omitempty"`
ServerVersion string `protobuf:"bytes,4,opt,name=server_version,json=serverVersion,proto3" json:"server_version,omitempty"`
IceServers []*ICEServer `protobuf:"bytes,5,rep,name=ice_servers,json=iceServers,proto3" json:"ice_servers,omitempty"`
// contains filtered or unexported fields
}
func (*JoinResponse) Descriptor
deprecated
func (*JoinResponse) Descriptor() ([]byte, []int)
Deprecated: Use JoinResponse.ProtoReflect.Descriptor instead.
func (*JoinResponse) GetIceServers ¶
func (x *JoinResponse) GetIceServers() []*ICEServer
func (*JoinResponse) GetOtherParticipants ¶
func (x *JoinResponse) GetOtherParticipants() []*ParticipantInfo
func (*JoinResponse) GetParticipant ¶
func (x *JoinResponse) GetParticipant() *ParticipantInfo
func (*JoinResponse) GetRoom ¶
func (x *JoinResponse) GetRoom() *Room
func (*JoinResponse) GetServerVersion ¶
func (x *JoinResponse) GetServerVersion() string
func (*JoinResponse) ProtoMessage ¶
func (*JoinResponse) ProtoMessage()
func (*JoinResponse) ProtoReflect ¶
func (x *JoinResponse) ProtoReflect() protoreflect.Message
func (*JoinResponse) Reset ¶
func (x *JoinResponse) Reset()
func (*JoinResponse) String ¶
func (x *JoinResponse) String() string
type LeaveRequest ¶
type LeaveRequest struct {
// sent when server initiates the disconnect due to server-restart
// indicates clients should attempt full-reconnect sequence
CanReconnect bool `protobuf:"varint,1,opt,name=can_reconnect,json=canReconnect,proto3" json:"can_reconnect,omitempty"`
// contains filtered or unexported fields
}
func (*LeaveRequest) Descriptor
deprecated
func (*LeaveRequest) Descriptor() ([]byte, []int)
Deprecated: Use LeaveRequest.ProtoReflect.Descriptor instead.
func (*LeaveRequest) GetCanReconnect ¶ added in v0.5.12
func (x *LeaveRequest) GetCanReconnect() bool
func (*LeaveRequest) ProtoMessage ¶
func (*LeaveRequest) ProtoMessage()
func (*LeaveRequest) ProtoReflect ¶
func (x *LeaveRequest) ProtoReflect() protoreflect.Message
func (*LeaveRequest) Reset ¶
func (x *LeaveRequest) Reset()
func (*LeaveRequest) String ¶
func (x *LeaveRequest) String() string
type ListParticipantsRequest ¶
type ListParticipantsRequest struct {
// name of the room
Room string `protobuf:"bytes,1,opt,name=room,proto3" json:"room,omitempty"`
// contains filtered or unexported fields
}
func (*ListParticipantsRequest) Descriptor
deprecated
func (*ListParticipantsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListParticipantsRequest.ProtoReflect.Descriptor instead.
func (*ListParticipantsRequest) GetRoom ¶
func (x *ListParticipantsRequest) GetRoom() string
func (*ListParticipantsRequest) ProtoMessage ¶
func (*ListParticipantsRequest) ProtoMessage()
func (*ListParticipantsRequest) ProtoReflect ¶
func (x *ListParticipantsRequest) ProtoReflect() protoreflect.Message
func (*ListParticipantsRequest) Reset ¶
func (x *ListParticipantsRequest) Reset()
func (*ListParticipantsRequest) String ¶
func (x *ListParticipantsRequest) String() string
type ListParticipantsResponse ¶
type ListParticipantsResponse struct {
Participants []*ParticipantInfo `protobuf:"bytes,1,rep,name=participants,proto3" json:"participants,omitempty"`
// contains filtered or unexported fields
}
func (*ListParticipantsResponse) Descriptor
deprecated
func (*ListParticipantsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListParticipantsResponse.ProtoReflect.Descriptor instead.
func (*ListParticipantsResponse) GetParticipants ¶
func (x *ListParticipantsResponse) GetParticipants() []*ParticipantInfo
func (*ListParticipantsResponse) ProtoMessage ¶
func (*ListParticipantsResponse) ProtoMessage()
func (*ListParticipantsResponse) ProtoReflect ¶
func (x *ListParticipantsResponse) ProtoReflect() protoreflect.Message
func (*ListParticipantsResponse) Reset ¶
func (x *ListParticipantsResponse) Reset()
func (*ListParticipantsResponse) String ¶
func (x *ListParticipantsResponse) String() string
type ListRoomsRequest ¶
type ListRoomsRequest struct {
// contains filtered or unexported fields
}
func (*ListRoomsRequest) Descriptor
deprecated
func (*ListRoomsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListRoomsRequest.ProtoReflect.Descriptor instead.
func (*ListRoomsRequest) ProtoMessage ¶
func (*ListRoomsRequest) ProtoMessage()
func (*ListRoomsRequest) ProtoReflect ¶
func (x *ListRoomsRequest) ProtoReflect() protoreflect.Message
func (*ListRoomsRequest) Reset ¶
func (x *ListRoomsRequest) Reset()
func (*ListRoomsRequest) String ¶
func (x *ListRoomsRequest) String() string
type ListRoomsResponse ¶
type ListRoomsResponse struct {
Rooms []*Room `protobuf:"bytes,1,rep,name=rooms,proto3" json:"rooms,omitempty"`
// contains filtered or unexported fields
}
func (*ListRoomsResponse) Descriptor
deprecated
func (*ListRoomsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListRoomsResponse.ProtoReflect.Descriptor instead.
func (*ListRoomsResponse) GetRooms ¶
func (x *ListRoomsResponse) GetRooms() []*Room
func (*ListRoomsResponse) ProtoMessage ¶
func (*ListRoomsResponse) ProtoMessage()
func (*ListRoomsResponse) ProtoReflect ¶
func (x *ListRoomsResponse) ProtoReflect() protoreflect.Message
func (*ListRoomsResponse) Reset ¶
func (x *ListRoomsResponse) Reset()
func (*ListRoomsResponse) String ¶
func (x *ListRoomsResponse) String() string
type MuteRoomTrackRequest ¶
type MuteRoomTrackRequest struct {
// name of the room
Room string `protobuf:"bytes,1,opt,name=room,proto3" json:"room,omitempty"`
Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
// sid of the track to mute
TrackSid string `protobuf:"bytes,3,opt,name=track_sid,json=trackSid,proto3" json:"track_sid,omitempty"`
// set to true to mute, false to unmute
Muted bool `protobuf:"varint,4,opt,name=muted,proto3" json:"muted,omitempty"`
// contains filtered or unexported fields
}
func (*MuteRoomTrackRequest) Descriptor
deprecated
func (*MuteRoomTrackRequest) Descriptor() ([]byte, []int)
Deprecated: Use MuteRoomTrackRequest.ProtoReflect.Descriptor instead.
func (*MuteRoomTrackRequest) GetIdentity ¶
func (x *MuteRoomTrackRequest) GetIdentity() string
func (*MuteRoomTrackRequest) GetMuted ¶
func (x *MuteRoomTrackRequest) GetMuted() bool
func (*MuteRoomTrackRequest) GetRoom ¶
func (x *MuteRoomTrackRequest) GetRoom() string
func (*MuteRoomTrackRequest) GetTrackSid ¶
func (x *MuteRoomTrackRequest) GetTrackSid() string
func (*MuteRoomTrackRequest) ProtoMessage ¶
func (*MuteRoomTrackRequest) ProtoMessage()
func (*MuteRoomTrackRequest) ProtoReflect ¶
func (x *MuteRoomTrackRequest) ProtoReflect() protoreflect.Message
func (*MuteRoomTrackRequest) Reset ¶
func (x *MuteRoomTrackRequest) Reset()
func (*MuteRoomTrackRequest) String ¶
func (x *MuteRoomTrackRequest) String() string
type MuteRoomTrackResponse ¶
type MuteRoomTrackResponse struct {
Track *TrackInfo `protobuf:"bytes,1,opt,name=track,proto3" json:"track,omitempty"`
// contains filtered or unexported fields
}
func (*MuteRoomTrackResponse) Descriptor
deprecated
func (*MuteRoomTrackResponse) Descriptor() ([]byte, []int)
Deprecated: Use MuteRoomTrackResponse.ProtoReflect.Descriptor instead.
func (*MuteRoomTrackResponse) GetTrack ¶
func (x *MuteRoomTrackResponse) GetTrack() *TrackInfo
func (*MuteRoomTrackResponse) ProtoMessage ¶
func (*MuteRoomTrackResponse) ProtoMessage()
func (*MuteRoomTrackResponse) ProtoReflect ¶
func (x *MuteRoomTrackResponse) ProtoReflect() protoreflect.Message
func (*MuteRoomTrackResponse) Reset ¶
func (x *MuteRoomTrackResponse) Reset()
func (*MuteRoomTrackResponse) String ¶
func (x *MuteRoomTrackResponse) String() string
type MuteTrackRequest ¶
type MuteTrackRequest struct {
Sid string `protobuf:"bytes,1,opt,name=sid,proto3" json:"sid,omitempty"`
Muted bool `protobuf:"varint,2,opt,name=muted,proto3" json:"muted,omitempty"`
// contains filtered or unexported fields
}
func (*MuteTrackRequest) Descriptor
deprecated
func (*MuteTrackRequest) Descriptor() ([]byte, []int)
Deprecated: Use MuteTrackRequest.ProtoReflect.Descriptor instead.
func (*MuteTrackRequest) GetMuted ¶
func (x *MuteTrackRequest) GetMuted() bool
func (*MuteTrackRequest) GetSid ¶
func (x *MuteTrackRequest) GetSid() string
func (*MuteTrackRequest) ProtoMessage ¶
func (*MuteTrackRequest) ProtoMessage()
func (*MuteTrackRequest) ProtoReflect ¶
func (x *MuteTrackRequest) ProtoReflect() protoreflect.Message
func (*MuteTrackRequest) Reset ¶
func (x *MuteTrackRequest) Reset()
func (*MuteTrackRequest) String ¶
func (x *MuteTrackRequest) String() string
type ParticipantInfo ¶
type ParticipantInfo struct {
Sid string `protobuf:"bytes,1,opt,name=sid,proto3" json:"sid,omitempty"`
Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
State ParticipantInfo_State `protobuf:"varint,3,opt,name=state,proto3,enum=livekit.ParticipantInfo_State" json:"state,omitempty"`
Tracks []*TrackInfo `protobuf:"bytes,4,rep,name=tracks,proto3" json:"tracks,omitempty"`
Metadata string `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"`
// timestamp when participant joined room
JoinedAt int64 `protobuf:"varint,6,opt,name=joined_at,json=joinedAt,proto3" json:"joined_at,omitempty"`
// hidden participant (used for recording)
Hidden bool `protobuf:"varint,7,opt,name=hidden,proto3" json:"hidden,omitempty"`
// contains filtered or unexported fields
}
func (*ParticipantInfo) Descriptor
deprecated
func (*ParticipantInfo) Descriptor() ([]byte, []int)
Deprecated: Use ParticipantInfo.ProtoReflect.Descriptor instead.
func (*ParticipantInfo) GetHidden ¶ added in v0.5.13
func (x *ParticipantInfo) GetHidden() bool
func (*ParticipantInfo) GetIdentity ¶
func (x *ParticipantInfo) GetIdentity() string
func (*ParticipantInfo) GetJoinedAt ¶
func (x *ParticipantInfo) GetJoinedAt() int64
func (*ParticipantInfo) GetMetadata ¶
func (x *ParticipantInfo) GetMetadata() string
func (*ParticipantInfo) GetSid ¶
func (x *ParticipantInfo) GetSid() string
func (*ParticipantInfo) GetState ¶
func (x *ParticipantInfo) GetState() ParticipantInfo_State
func (*ParticipantInfo) GetTracks ¶
func (x *ParticipantInfo) GetTracks() []*TrackInfo
func (*ParticipantInfo) ProtoMessage ¶
func (*ParticipantInfo) ProtoMessage()
func (*ParticipantInfo) ProtoReflect ¶
func (x *ParticipantInfo) ProtoReflect() protoreflect.Message
func (*ParticipantInfo) Reset ¶
func (x *ParticipantInfo) Reset()
func (*ParticipantInfo) String ¶
func (x *ParticipantInfo) String() string
type ParticipantInfo_State ¶
type ParticipantInfo_State int32
const ( // websocket' connected, but not offered yet ParticipantInfo_JOINING ParticipantInfo_State = 0 // server received client offer ParticipantInfo_JOINED ParticipantInfo_State = 1 // ICE connectivity established ParticipantInfo_ACTIVE ParticipantInfo_State = 2 // WS disconnected ParticipantInfo_DISCONNECTED ParticipantInfo_State = 3 )
func (ParticipantInfo_State) Descriptor ¶
func (ParticipantInfo_State) Descriptor() protoreflect.EnumDescriptor
func (ParticipantInfo_State) Enum ¶
func (x ParticipantInfo_State) Enum() *ParticipantInfo_State
func (ParticipantInfo_State) EnumDescriptor
deprecated
func (ParticipantInfo_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use ParticipantInfo_State.Descriptor instead.
func (ParticipantInfo_State) Number ¶
func (x ParticipantInfo_State) Number() protoreflect.EnumNumber
func (ParticipantInfo_State) String ¶
func (x ParticipantInfo_State) String() string
func (ParticipantInfo_State) Type ¶
func (ParticipantInfo_State) Type() protoreflect.EnumType
type ParticipantPermission ¶
type ParticipantPermission struct {
// allow participant to subscribe to other tracks in the room
CanSubscribe bool `protobuf:"varint,1,opt,name=can_subscribe,json=canSubscribe,proto3" json:"can_subscribe,omitempty"`
// allow participant to publish new tracks to room
CanPublish bool `protobuf:"varint,2,opt,name=can_publish,json=canPublish,proto3" json:"can_publish,omitempty"`
// contains filtered or unexported fields
}
func (*ParticipantPermission) Descriptor
deprecated
func (*ParticipantPermission) Descriptor() ([]byte, []int)
Deprecated: Use ParticipantPermission.ProtoReflect.Descriptor instead.
func (*ParticipantPermission) GetCanPublish ¶
func (x *ParticipantPermission) GetCanPublish() bool
func (*ParticipantPermission) GetCanSubscribe ¶
func (x *ParticipantPermission) GetCanSubscribe() bool
func (*ParticipantPermission) ProtoMessage ¶
func (*ParticipantPermission) ProtoMessage()
func (*ParticipantPermission) ProtoReflect ¶
func (x *ParticipantPermission) ProtoReflect() protoreflect.Message
func (*ParticipantPermission) Reset ¶
func (x *ParticipantPermission) Reset()
func (*ParticipantPermission) String ¶
func (x *ParticipantPermission) String() string
type ParticipantUpdate ¶
type ParticipantUpdate struct {
Participants []*ParticipantInfo `protobuf:"bytes,1,rep,name=participants,proto3" json:"participants,omitempty"`
// contains filtered or unexported fields
}
func (*ParticipantUpdate) Descriptor
deprecated
func (*ParticipantUpdate) Descriptor() ([]byte, []int)
Deprecated: Use ParticipantUpdate.ProtoReflect.Descriptor instead.
func (*ParticipantUpdate) GetParticipants ¶
func (x *ParticipantUpdate) GetParticipants() []*ParticipantInfo
func (*ParticipantUpdate) ProtoMessage ¶
func (*ParticipantUpdate) ProtoMessage()
func (*ParticipantUpdate) ProtoReflect ¶
func (x *ParticipantUpdate) ProtoReflect() protoreflect.Message
func (*ParticipantUpdate) Reset ¶
func (x *ParticipantUpdate) Reset()
func (*ParticipantUpdate) String ¶
func (x *ParticipantUpdate) String() string
type RecordingOptions ¶ added in v0.6.1
type RecordingOptions struct {
// 720p30, 720p60, 1080p30, or 1080p60
Preset string `protobuf:"bytes,1,opt,name=preset,proto3" json:"preset,omitempty"`
InputWidth int32 `protobuf:"varint,2,opt,name=input_width,json=inputWidth,proto3" json:"input_width,omitempty"`
InputHeight int32 `protobuf:"varint,3,opt,name=input_height,json=inputHeight,proto3" json:"input_height,omitempty"`
OutputWidth int32 `protobuf:"varint,4,opt,name=output_width,json=outputWidth,proto3" json:"output_width,omitempty"`
OutputHeight int32 `protobuf:"varint,5,opt,name=output_height,json=outputHeight,proto3" json:"output_height,omitempty"`
Depth int32 `protobuf:"varint,6,opt,name=depth,proto3" json:"depth,omitempty"`
Framerate int32 `protobuf:"varint,7,opt,name=framerate,proto3" json:"framerate,omitempty"`
AudioBitrate int32 `protobuf:"varint,8,opt,name=audio_bitrate,json=audioBitrate,proto3" json:"audio_bitrate,omitempty"`
AudioFrequency int32 `protobuf:"varint,9,opt,name=audio_frequency,json=audioFrequency,proto3" json:"audio_frequency,omitempty"`
VideoBitrate int32 `protobuf:"varint,10,opt,name=video_bitrate,json=videoBitrate,proto3" json:"video_bitrate,omitempty"`
// contains filtered or unexported fields
}
func (*RecordingOptions) Descriptor
deprecated
added in
v0.6.1
func (*RecordingOptions) Descriptor() ([]byte, []int)
Deprecated: Use RecordingOptions.ProtoReflect.Descriptor instead.
func (*RecordingOptions) GetAudioBitrate ¶ added in v0.6.1
func (x *RecordingOptions) GetAudioBitrate() int32
func (*RecordingOptions) GetAudioFrequency ¶ added in v0.6.1
func (x *RecordingOptions) GetAudioFrequency() int32
func (*RecordingOptions) GetDepth ¶ added in v0.6.1
func (x *RecordingOptions) GetDepth() int32
func (*RecordingOptions) GetFramerate ¶ added in v0.6.1
func (x *RecordingOptions) GetFramerate() int32
func (*RecordingOptions) GetInputHeight ¶ added in v0.6.1
func (x *RecordingOptions) GetInputHeight() int32
func (*RecordingOptions) GetInputWidth ¶ added in v0.6.1
func (x *RecordingOptions) GetInputWidth() int32
func (*RecordingOptions) GetOutputHeight ¶ added in v0.6.1
func (x *RecordingOptions) GetOutputHeight() int32
func (*RecordingOptions) GetOutputWidth ¶ added in v0.6.1
func (x *RecordingOptions) GetOutputWidth() int32
func (*RecordingOptions) GetPreset ¶ added in v0.6.1
func (x *RecordingOptions) GetPreset() string
func (*RecordingOptions) GetVideoBitrate ¶ added in v0.6.1
func (x *RecordingOptions) GetVideoBitrate() int32
func (*RecordingOptions) ProtoMessage ¶ added in v0.6.1
func (*RecordingOptions) ProtoMessage()
func (*RecordingOptions) ProtoReflect ¶ added in v0.6.1
func (x *RecordingOptions) ProtoReflect() protoreflect.Message
func (*RecordingOptions) Reset ¶ added in v0.6.1
func (x *RecordingOptions) Reset()
func (*RecordingOptions) String ¶ added in v0.6.1
func (x *RecordingOptions) String() string
type RecordingResponse ¶ added in v0.6.1
type RecordingResponse struct {
RecordingId string `protobuf:"bytes,1,opt,name=recording_id,json=recordingId,proto3" json:"recording_id,omitempty"`
// contains filtered or unexported fields
}
func (*RecordingResponse) Descriptor
deprecated
added in
v0.6.1
func (*RecordingResponse) Descriptor() ([]byte, []int)
Deprecated: Use RecordingResponse.ProtoReflect.Descriptor instead.
func (*RecordingResponse) GetRecordingId ¶ added in v0.6.1
func (x *RecordingResponse) GetRecordingId() string
func (*RecordingResponse) ProtoMessage ¶ added in v0.6.1
func (*RecordingResponse) ProtoMessage()
func (*RecordingResponse) ProtoReflect ¶ added in v0.6.1
func (x *RecordingResponse) ProtoReflect() protoreflect.Message
func (*RecordingResponse) Reset ¶ added in v0.6.1
func (x *RecordingResponse) Reset()
func (*RecordingResponse) String ¶ added in v0.6.1
func (x *RecordingResponse) String() string
type RecordingS3Output ¶ added in v0.6.1
type RecordingS3Output struct {
Bucket string `protobuf:"bytes,1,opt,name=bucket,proto3" json:"bucket,omitempty"`
Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
// optional
AccessKey string `protobuf:"bytes,3,opt,name=access_key,json=accessKey,proto3" json:"access_key,omitempty"`
Secret string `protobuf:"bytes,4,opt,name=secret,proto3" json:"secret,omitempty"`
// contains filtered or unexported fields
}
func (*RecordingS3Output) Descriptor
deprecated
added in
v0.6.1
func (*RecordingS3Output) Descriptor() ([]byte, []int)
Deprecated: Use RecordingS3Output.ProtoReflect.Descriptor instead.
func (*RecordingS3Output) GetAccessKey ¶ added in v0.6.1
func (x *RecordingS3Output) GetAccessKey() string
func (*RecordingS3Output) GetBucket ¶ added in v0.6.1
func (x *RecordingS3Output) GetBucket() string
func (*RecordingS3Output) GetKey ¶ added in v0.6.1
func (x *RecordingS3Output) GetKey() string
func (*RecordingS3Output) GetSecret ¶ added in v0.6.1
func (x *RecordingS3Output) GetSecret() string
func (*RecordingS3Output) ProtoMessage ¶ added in v0.6.1
func (*RecordingS3Output) ProtoMessage()
func (*RecordingS3Output) ProtoReflect ¶ added in v0.6.1
func (x *RecordingS3Output) ProtoReflect() protoreflect.Message
func (*RecordingS3Output) Reset ¶ added in v0.6.1
func (x *RecordingS3Output) Reset()
func (*RecordingS3Output) String ¶ added in v0.6.1
func (x *RecordingS3Output) String() string
type RecordingService ¶ added in v0.6.1
type RecordingService interface {
// Starts a room
StartRecording(context.Context, *StartRecordingRequest) (*RecordingResponse, error)
// Ends a recording
EndRecording(context.Context, *EndRecordingRequest) (*RecordingResponse, error)
}
Recording service that can be performed on any node they are Twirp-based HTTP req/responses
func NewRecordingServiceJSONClient ¶ added in v0.6.1
func NewRecordingServiceJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) RecordingService
NewRecordingServiceJSONClient creates a JSON client that implements the RecordingService interface. It communicates using JSON and can be configured with a custom HTTPClient.
func NewRecordingServiceProtobufClient ¶ added in v0.6.1
func NewRecordingServiceProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) RecordingService
NewRecordingServiceProtobufClient creates a Protobuf client that implements the RecordingService interface. It communicates using Protobuf and can be configured with a custom HTTPClient.
type RecordingTemplate ¶ added in v0.6.1
type RecordingTemplate struct {
Layout string `protobuf:"bytes,1,opt,name=layout,proto3" json:"layout,omitempty"`
WsUrl string `protobuf:"bytes,2,opt,name=ws_url,json=wsUrl,proto3" json:"ws_url,omitempty"`
// either token or room name required
Token string `protobuf:"bytes,3,opt,name=token,proto3" json:"token,omitempty"`
RoomName string `protobuf:"bytes,4,opt,name=room_name,json=roomName,proto3" json:"room_name,omitempty"`
// contains filtered or unexported fields
}
func (*RecordingTemplate) Descriptor
deprecated
added in
v0.6.1
func (*RecordingTemplate) Descriptor() ([]byte, []int)
Deprecated: Use RecordingTemplate.ProtoReflect.Descriptor instead.
func (*RecordingTemplate) GetLayout ¶ added in v0.6.1
func (x *RecordingTemplate) GetLayout() string
func (*RecordingTemplate) GetRoomName ¶ added in v0.6.1
func (x *RecordingTemplate) GetRoomName() string
func (*RecordingTemplate) GetToken ¶ added in v0.6.1
func (x *RecordingTemplate) GetToken() string
func (*RecordingTemplate) GetWsUrl ¶ added in v0.6.1
func (x *RecordingTemplate) GetWsUrl() string
func (*RecordingTemplate) ProtoMessage ¶ added in v0.6.1
func (*RecordingTemplate) ProtoMessage()
func (*RecordingTemplate) ProtoReflect ¶ added in v0.6.1
func (x *RecordingTemplate) ProtoReflect() protoreflect.Message
func (*RecordingTemplate) Reset ¶ added in v0.6.1
func (x *RecordingTemplate) Reset()
func (*RecordingTemplate) String ¶ added in v0.6.1
func (x *RecordingTemplate) String() string
type RemoveParticipantResponse ¶
type RemoveParticipantResponse struct {
// contains filtered or unexported fields
}
func (*RemoveParticipantResponse) Descriptor
deprecated
func (*RemoveParticipantResponse) Descriptor() ([]byte, []int)
Deprecated: Use RemoveParticipantResponse.ProtoReflect.Descriptor instead.
func (*RemoveParticipantResponse) ProtoMessage ¶
func (*RemoveParticipantResponse) ProtoMessage()
func (*RemoveParticipantResponse) ProtoReflect ¶
func (x *RemoveParticipantResponse) ProtoReflect() protoreflect.Message
func (*RemoveParticipantResponse) Reset ¶
func (x *RemoveParticipantResponse) Reset()
func (*RemoveParticipantResponse) String ¶
func (x *RemoveParticipantResponse) String() string
type Room ¶
type Room struct {
Sid string `protobuf:"bytes,1,opt,name=sid,proto3" json:"sid,omitempty"`
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
EmptyTimeout uint32 `protobuf:"varint,3,opt,name=empty_timeout,json=emptyTimeout,proto3" json:"empty_timeout,omitempty"`
MaxParticipants uint32 `protobuf:"varint,4,opt,name=max_participants,json=maxParticipants,proto3" json:"max_participants,omitempty"`
CreationTime int64 `protobuf:"varint,5,opt,name=creation_time,json=creationTime,proto3" json:"creation_time,omitempty"`
TurnPassword string `protobuf:"bytes,6,opt,name=turn_password,json=turnPassword,proto3" json:"turn_password,omitempty"`
EnabledCodecs []*Codec `protobuf:"bytes,7,rep,name=enabled_codecs,json=enabledCodecs,proto3" json:"enabled_codecs,omitempty"`
// contains filtered or unexported fields
}
func (*Room) Descriptor
deprecated
func (*Room) GetCreationTime ¶
func (*Room) GetEmptyTimeout ¶
func (*Room) GetEnabledCodecs ¶ added in v0.5.11
func (*Room) GetMaxParticipants ¶
func (*Room) GetTurnPassword ¶
func (*Room) ProtoMessage ¶
func (*Room) ProtoMessage()
func (*Room) ProtoReflect ¶
func (x *Room) ProtoReflect() protoreflect.Message
type RoomParticipantIdentity ¶
type RoomParticipantIdentity struct {
// name of the room
Room string `protobuf:"bytes,1,opt,name=room,proto3" json:"room,omitempty"`
// identity of the participant
Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
// contains filtered or unexported fields
}
func (*RoomParticipantIdentity) Descriptor
deprecated
func (*RoomParticipantIdentity) Descriptor() ([]byte, []int)
Deprecated: Use RoomParticipantIdentity.ProtoReflect.Descriptor instead.
func (*RoomParticipantIdentity) GetIdentity ¶
func (x *RoomParticipantIdentity) GetIdentity() string
func (*RoomParticipantIdentity) GetRoom ¶
func (x *RoomParticipantIdentity) GetRoom() string
func (*RoomParticipantIdentity) ProtoMessage ¶
func (*RoomParticipantIdentity) ProtoMessage()
func (*RoomParticipantIdentity) ProtoReflect ¶
func (x *RoomParticipantIdentity) ProtoReflect() protoreflect.Message
func (*RoomParticipantIdentity) Reset ¶
func (x *RoomParticipantIdentity) Reset()
func (*RoomParticipantIdentity) String ¶
func (x *RoomParticipantIdentity) String() string
type RoomService ¶
type RoomService interface {
// Creates a room with settings. Requires `roomCreate` permission.
// This method is optional; rooms are automatically created when clients connect to them for the first time.
CreateRoom(context.Context, *CreateRoomRequest) (*Room, error)
// List rooms that are active on the server. Requires `roomList` permission.
ListRooms(context.Context, *ListRoomsRequest) (*ListRoomsResponse, error)
// Deletes an existing room by name or id. Requires `roomCreate` permission.
// DeleteRoom will disconnect all participants that are currently in the room.
DeleteRoom(context.Context, *DeleteRoomRequest) (*DeleteRoomResponse, error)
// Lists participants in a room, Requires `roomAdmin`
ListParticipants(context.Context, *ListParticipantsRequest) (*ListParticipantsResponse, error)
// Get information on a specific participant, Requires `roomAdmin`
GetParticipant(context.Context, *RoomParticipantIdentity) (*ParticipantInfo, error)
// Removes a participant from room. Requires `roomAdmin`
RemoveParticipant(context.Context, *RoomParticipantIdentity) (*RemoveParticipantResponse, error)
// Mute/unmute a participant's track, Requires `roomAdmin`
MutePublishedTrack(context.Context, *MuteRoomTrackRequest) (*MuteRoomTrackResponse, error)
// Update participant metadata, will cause updates to be broadcasted to everyone in the room. Requires `roomAdmin`
UpdateParticipant(context.Context, *UpdateParticipantRequest) (*ParticipantInfo, error)
// Subscribes or unsubscribe a participant from tracks. Requires `roomAdmin`
UpdateSubscriptions(context.Context, *UpdateSubscriptionsRequest) (*UpdateSubscriptionsResponse, error)
}
Room service that can be performed on any node they are Twirp-based HTTP req/responses
func NewRoomServiceJSONClient ¶
func NewRoomServiceJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) RoomService
NewRoomServiceJSONClient creates a JSON client that implements the RoomService interface. It communicates using JSON and can be configured with a custom HTTPClient.
func NewRoomServiceProtobufClient ¶
func NewRoomServiceProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) RoomService
NewRoomServiceProtobufClient creates a Protobuf client that implements the RoomService interface. It communicates using Protobuf and can be configured with a custom HTTPClient.
type SessionDescription ¶
type SessionDescription struct {
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // "answer" | "offer" | "pranswer" | "rollback"
Sdp string `protobuf:"bytes,2,opt,name=sdp,proto3" json:"sdp,omitempty"`
// contains filtered or unexported fields
}
func (*SessionDescription) Descriptor
deprecated
func (*SessionDescription) Descriptor() ([]byte, []int)
Deprecated: Use SessionDescription.ProtoReflect.Descriptor instead.
func (*SessionDescription) GetSdp ¶
func (x *SessionDescription) GetSdp() string
func (*SessionDescription) GetType ¶
func (x *SessionDescription) GetType() string
func (*SessionDescription) ProtoMessage ¶
func (*SessionDescription) ProtoMessage()
func (*SessionDescription) ProtoReflect ¶
func (x *SessionDescription) ProtoReflect() protoreflect.Message
func (*SessionDescription) Reset ¶
func (x *SessionDescription) Reset()
func (*SessionDescription) String ¶
func (x *SessionDescription) String() string
type SetSimulcastLayers ¶ added in v0.5.12
type SetSimulcastLayers struct {
TrackSid string `protobuf:"bytes,1,opt,name=track_sid,json=trackSid,proto3" json:"track_sid,omitempty"`
Layers []VideoQuality `protobuf:"varint,2,rep,packed,name=layers,proto3,enum=livekit.VideoQuality" json:"layers,omitempty"`
// contains filtered or unexported fields
}
func (*SetSimulcastLayers) Descriptor
deprecated
added in
v0.5.12
func (*SetSimulcastLayers) Descriptor() ([]byte, []int)
Deprecated: Use SetSimulcastLayers.ProtoReflect.Descriptor instead.
func (*SetSimulcastLayers) GetLayers ¶ added in v0.5.12
func (x *SetSimulcastLayers) GetLayers() []VideoQuality
func (*SetSimulcastLayers) GetTrackSid ¶ added in v0.5.12
func (x *SetSimulcastLayers) GetTrackSid() string
func (*SetSimulcastLayers) ProtoMessage ¶ added in v0.5.12
func (*SetSimulcastLayers) ProtoMessage()
func (*SetSimulcastLayers) ProtoReflect ¶ added in v0.5.12
func (x *SetSimulcastLayers) ProtoReflect() protoreflect.Message
func (*SetSimulcastLayers) Reset ¶ added in v0.5.12
func (x *SetSimulcastLayers) Reset()
func (*SetSimulcastLayers) String ¶ added in v0.5.12
func (x *SetSimulcastLayers) String() string
type SignalRequest ¶
type SignalRequest struct {
// Types that are assignable to Message:
// *SignalRequest_Offer
// *SignalRequest_Answer
// *SignalRequest_Trickle
// *SignalRequest_AddTrack
// *SignalRequest_Mute
// *SignalRequest_Subscription
// *SignalRequest_TrackSetting
// *SignalRequest_Leave
// *SignalRequest_Simulcast
Message isSignalRequest_Message `protobuf_oneof:"message"`
// contains filtered or unexported fields
}
func (*SignalRequest) Descriptor
deprecated
func (*SignalRequest) Descriptor() ([]byte, []int)
Deprecated: Use SignalRequest.ProtoReflect.Descriptor instead.
func (*SignalRequest) GetAddTrack ¶
func (x *SignalRequest) GetAddTrack() *AddTrackRequest
func (*SignalRequest) GetAnswer ¶
func (x *SignalRequest) GetAnswer() *SessionDescription
func (*SignalRequest) GetLeave ¶
func (x *SignalRequest) GetLeave() *LeaveRequest
func (*SignalRequest) GetMessage ¶
func (m *SignalRequest) GetMessage() isSignalRequest_Message
func (*SignalRequest) GetMute ¶
func (x *SignalRequest) GetMute() *MuteTrackRequest
func (*SignalRequest) GetOffer ¶
func (x *SignalRequest) GetOffer() *SessionDescription
func (*SignalRequest) GetSimulcast ¶ added in v0.5.12
func (x *SignalRequest) GetSimulcast() *SetSimulcastLayers
func (*SignalRequest) GetSubscription ¶
func (x *SignalRequest) GetSubscription() *UpdateSubscription
func (*SignalRequest) GetTrackSetting ¶
func (x *SignalRequest) GetTrackSetting() *UpdateTrackSettings
func (*SignalRequest) GetTrickle ¶
func (x *SignalRequest) GetTrickle() *TrickleRequest
func (*SignalRequest) ProtoMessage ¶
func (*SignalRequest) ProtoMessage()
func (*SignalRequest) ProtoReflect ¶
func (x *SignalRequest) ProtoReflect() protoreflect.Message
func (*SignalRequest) Reset ¶
func (x *SignalRequest) Reset()
func (*SignalRequest) String ¶
func (x *SignalRequest) String() string
type SignalRequest_AddTrack ¶
type SignalRequest_AddTrack struct {
AddTrack *AddTrackRequest `protobuf:"bytes,4,opt,name=add_track,json=addTrack,proto3,oneof"`
}
type SignalRequest_Answer ¶
type SignalRequest_Answer struct {
// participant answering publisher offer
Answer *SessionDescription `protobuf:"bytes,2,opt,name=answer,proto3,oneof"`
}
type SignalRequest_Leave ¶
type SignalRequest_Leave struct {
// Immediately terminate session
Leave *LeaveRequest `protobuf:"bytes,8,opt,name=leave,proto3,oneof"`
}
type SignalRequest_Mute ¶
type SignalRequest_Mute struct {
// mute the participant's published tracks
Mute *MuteTrackRequest `protobuf:"bytes,5,opt,name=mute,proto3,oneof"`
}
type SignalRequest_Offer ¶
type SignalRequest_Offer struct {
// initial join exchange, for publisher
Offer *SessionDescription `protobuf:"bytes,1,opt,name=offer,proto3,oneof"`
}
type SignalRequest_Simulcast ¶ added in v0.5.12
type SignalRequest_Simulcast struct {
// Set active published layers
Simulcast *SetSimulcastLayers `protobuf:"bytes,9,opt,name=simulcast,proto3,oneof"`
}
type SignalRequest_Subscription ¶
type SignalRequest_Subscription struct {
// Subscribe or unsubscribe from tracks
Subscription *UpdateSubscription `protobuf:"bytes,6,opt,name=subscription,proto3,oneof"`
}
type SignalRequest_TrackSetting ¶
type SignalRequest_TrackSetting struct {
// Update settings of subscribed tracks
TrackSetting *UpdateTrackSettings `protobuf:"bytes,7,opt,name=track_setting,json=trackSetting,proto3,oneof"`
}
type SignalRequest_Trickle ¶
type SignalRequest_Trickle struct {
Trickle *TrickleRequest `protobuf:"bytes,3,opt,name=trickle,proto3,oneof"`
}
type SignalResponse ¶
type SignalResponse struct {
// Types that are assignable to Message:
// *SignalResponse_Join
// *SignalResponse_Answer
// *SignalResponse_Offer
// *SignalResponse_Trickle
// *SignalResponse_Update
// *SignalResponse_TrackPublished
// *SignalResponse_Speaker
// *SignalResponse_Leave
Message isSignalResponse_Message `protobuf_oneof:"message"`
// contains filtered or unexported fields
}
func (*SignalResponse) Descriptor
deprecated
func (*SignalResponse) Descriptor() ([]byte, []int)
Deprecated: Use SignalResponse.ProtoReflect.Descriptor instead.
func (*SignalResponse) GetAnswer ¶
func (x *SignalResponse) GetAnswer() *SessionDescription
func (*SignalResponse) GetJoin ¶
func (x *SignalResponse) GetJoin() *JoinResponse
func (*SignalResponse) GetLeave ¶
func (x *SignalResponse) GetLeave() *LeaveRequest
func (*SignalResponse) GetMessage ¶
func (m *SignalResponse) GetMessage() isSignalResponse_Message
func (*SignalResponse) GetOffer ¶
func (x *SignalResponse) GetOffer() *SessionDescription
func (*SignalResponse) GetSpeaker ¶
func (x *SignalResponse) GetSpeaker() *ActiveSpeakerUpdate
func (*SignalResponse) GetTrackPublished ¶
func (x *SignalResponse) GetTrackPublished() *TrackPublishedResponse
func (*SignalResponse) GetTrickle ¶
func (x *SignalResponse) GetTrickle() *TrickleRequest
func (*SignalResponse) GetUpdate ¶
func (x *SignalResponse) GetUpdate() *ParticipantUpdate
func (*SignalResponse) ProtoMessage ¶
func (*SignalResponse) ProtoMessage()
func (*SignalResponse) ProtoReflect ¶
func (x *SignalResponse) ProtoReflect() protoreflect.Message
func (*SignalResponse) Reset ¶
func (x *SignalResponse) Reset()
func (*SignalResponse) String ¶
func (x *SignalResponse) String() string
type SignalResponse_Answer ¶
type SignalResponse_Answer struct {
// sent when server answers publisher
Answer *SessionDescription `protobuf:"bytes,2,opt,name=answer,proto3,oneof"`
}
type SignalResponse_Join ¶
type SignalResponse_Join struct {
// sent when join is accepted
Join *JoinResponse `protobuf:"bytes,1,opt,name=join,proto3,oneof"`
}
type SignalResponse_Leave ¶
type SignalResponse_Leave struct {
// Immediately terminate session
Leave *LeaveRequest `protobuf:"bytes,8,opt,name=leave,proto3,oneof"`
}
type SignalResponse_Offer ¶
type SignalResponse_Offer struct {
// sent when server is sending subscriber an offer
Offer *SessionDescription `protobuf:"bytes,3,opt,name=offer,proto3,oneof"`
}
type SignalResponse_Speaker ¶
type SignalResponse_Speaker struct {
// list of active speakers
Speaker *ActiveSpeakerUpdate `protobuf:"bytes,7,opt,name=speaker,proto3,oneof"`
}
type SignalResponse_TrackPublished ¶
type SignalResponse_TrackPublished struct {
// sent to the participant when their track has been published
TrackPublished *TrackPublishedResponse `protobuf:"bytes,6,opt,name=track_published,json=trackPublished,proto3,oneof"`
}
type SignalResponse_Trickle ¶
type SignalResponse_Trickle struct {
// sent when an ICE candidate is available
Trickle *TrickleRequest `protobuf:"bytes,4,opt,name=trickle,proto3,oneof"`
}
type SignalResponse_Update ¶
type SignalResponse_Update struct {
// sent when participants in the room has changed
Update *ParticipantUpdate `protobuf:"bytes,5,opt,name=update,proto3,oneof"`
}
type SignalTarget ¶
type SignalTarget int32
const ( SignalTarget_PUBLISHER SignalTarget = 0 SignalTarget_SUBSCRIBER SignalTarget = 1 )
func (SignalTarget) Descriptor ¶
func (SignalTarget) Descriptor() protoreflect.EnumDescriptor
func (SignalTarget) Enum ¶
func (x SignalTarget) Enum() *SignalTarget
func (SignalTarget) EnumDescriptor
deprecated
func (SignalTarget) EnumDescriptor() ([]byte, []int)
Deprecated: Use SignalTarget.Descriptor instead.
func (SignalTarget) Number ¶
func (x SignalTarget) Number() protoreflect.EnumNumber
func (SignalTarget) String ¶
func (x SignalTarget) String() string
func (SignalTarget) Type ¶
func (SignalTarget) Type() protoreflect.EnumType
type SpeakerInfo ¶
type SpeakerInfo struct {
Sid string `protobuf:"bytes,1,opt,name=sid,proto3" json:"sid,omitempty"`
// audio level, 0-1.0, 1 is loudest
Level float32 `protobuf:"fixed32,2,opt,name=level,proto3" json:"level,omitempty"`
// true if speaker is currently active
Active bool `protobuf:"varint,3,opt,name=active,proto3" json:"active,omitempty"`
// contains filtered or unexported fields
}
func (*SpeakerInfo) Descriptor
deprecated
func (*SpeakerInfo) Descriptor() ([]byte, []int)
Deprecated: Use SpeakerInfo.ProtoReflect.Descriptor instead.
func (*SpeakerInfo) GetActive ¶
func (x *SpeakerInfo) GetActive() bool
func (*SpeakerInfo) GetLevel ¶
func (x *SpeakerInfo) GetLevel() float32
func (*SpeakerInfo) GetSid ¶
func (x *SpeakerInfo) GetSid() string
func (*SpeakerInfo) ProtoMessage ¶
func (*SpeakerInfo) ProtoMessage()
func (*SpeakerInfo) ProtoReflect ¶
func (x *SpeakerInfo) ProtoReflect() protoreflect.Message
func (*SpeakerInfo) Reset ¶
func (x *SpeakerInfo) Reset()
func (*SpeakerInfo) String ¶
func (x *SpeakerInfo) String() string
type StartRecordingRequest ¶ added in v0.6.1
type StartRecordingRequest struct {
// Types that are assignable to Input:
// *StartRecordingRequest_Url
// *StartRecordingRequest_Template
Input isStartRecordingRequest_Input `protobuf_oneof:"input"`
// Types that are assignable to Output:
// *StartRecordingRequest_File
// *StartRecordingRequest_S3
// *StartRecordingRequest_Rtmp
Output isStartRecordingRequest_Output `protobuf_oneof:"output"`
Options *RecordingOptions `protobuf:"bytes,6,opt,name=options,proto3" json:"options,omitempty"`
// contains filtered or unexported fields
}
func (*StartRecordingRequest) Descriptor
deprecated
added in
v0.6.1
func (*StartRecordingRequest) Descriptor() ([]byte, []int)
Deprecated: Use StartRecordingRequest.ProtoReflect.Descriptor instead.
func (*StartRecordingRequest) GetFile ¶ added in v0.6.1
func (x *StartRecordingRequest) GetFile() string
func (*StartRecordingRequest) GetInput ¶ added in v0.6.1
func (m *StartRecordingRequest) GetInput() isStartRecordingRequest_Input
func (*StartRecordingRequest) GetOptions ¶ added in v0.6.1
func (x *StartRecordingRequest) GetOptions() *RecordingOptions
func (*StartRecordingRequest) GetOutput ¶ added in v0.6.1
func (m *StartRecordingRequest) GetOutput() isStartRecordingRequest_Output
func (*StartRecordingRequest) GetRtmp ¶ added in v0.6.1
func (x *StartRecordingRequest) GetRtmp() string
func (*StartRecordingRequest) GetS3 ¶ added in v0.6.1
func (x *StartRecordingRequest) GetS3() *RecordingS3Output
func (*StartRecordingRequest) GetTemplate ¶ added in v0.6.1
func (x *StartRecordingRequest) GetTemplate() *RecordingTemplate
func (*StartRecordingRequest) GetUrl ¶ added in v0.6.1
func (x *StartRecordingRequest) GetUrl() string
func (*StartRecordingRequest) ProtoMessage ¶ added in v0.6.1
func (*StartRecordingRequest) ProtoMessage()
func (*StartRecordingRequest) ProtoReflect ¶ added in v0.6.1
func (x *StartRecordingRequest) ProtoReflect() protoreflect.Message
func (*StartRecordingRequest) Reset ¶ added in v0.6.1
func (x *StartRecordingRequest) Reset()
func (*StartRecordingRequest) String ¶ added in v0.6.1
func (x *StartRecordingRequest) String() string
type StartRecordingRequest_File ¶ added in v0.6.1
type StartRecordingRequest_File struct {
File string `protobuf:"bytes,3,opt,name=file,proto3,oneof"`
}
type StartRecordingRequest_Rtmp ¶ added in v0.6.1
type StartRecordingRequest_Rtmp struct {
Rtmp string `protobuf:"bytes,5,opt,name=rtmp,proto3,oneof"`
}
type StartRecordingRequest_S3 ¶ added in v0.6.1
type StartRecordingRequest_S3 struct {
S3 *RecordingS3Output `protobuf:"bytes,4,opt,name=s3,proto3,oneof"`
}
type StartRecordingRequest_Template ¶ added in v0.6.1
type StartRecordingRequest_Template struct {
Template *RecordingTemplate `protobuf:"bytes,2,opt,name=template,proto3,oneof"`
}
type StartRecordingRequest_Url ¶ added in v0.6.1
type StartRecordingRequest_Url struct {
Url string `protobuf:"bytes,1,opt,name=url,proto3,oneof"`
}
type TrackInfo ¶
type TrackInfo struct {
Sid string `protobuf:"bytes,1,opt,name=sid,proto3" json:"sid,omitempty"`
Type TrackType `protobuf:"varint,2,opt,name=type,proto3,enum=livekit.TrackType" json:"type,omitempty"`
Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
Muted bool `protobuf:"varint,4,opt,name=muted,proto3" json:"muted,omitempty"`
// original width of video (unset for audio)
// clients may receive a lower resolution version with simulcast
Width uint32 `protobuf:"varint,5,opt,name=width,proto3" json:"width,omitempty"`
// original height of video (unset for audio)
Height uint32 `protobuf:"varint,6,opt,name=height,proto3" json:"height,omitempty"`
// true if track is simulcasted
Simulcast bool `protobuf:"varint,7,opt,name=simulcast,proto3" json:"simulcast,omitempty"`
// contains filtered or unexported fields
}
func (*TrackInfo) Descriptor
deprecated
func (*TrackInfo) GetSimulcast ¶
func (*TrackInfo) ProtoMessage ¶
func (*TrackInfo) ProtoMessage()
func (*TrackInfo) ProtoReflect ¶
func (x *TrackInfo) ProtoReflect() protoreflect.Message
type TrackPublishedResponse ¶
type TrackPublishedResponse struct {
Cid string `protobuf:"bytes,1,opt,name=cid,proto3" json:"cid,omitempty"`
Track *TrackInfo `protobuf:"bytes,2,opt,name=track,proto3" json:"track,omitempty"`
// contains filtered or unexported fields
}
func (*TrackPublishedResponse) Descriptor
deprecated
func (*TrackPublishedResponse) Descriptor() ([]byte, []int)
Deprecated: Use TrackPublishedResponse.ProtoReflect.Descriptor instead.
func (*TrackPublishedResponse) GetCid ¶
func (x *TrackPublishedResponse) GetCid() string
func (*TrackPublishedResponse) GetTrack ¶
func (x *TrackPublishedResponse) GetTrack() *TrackInfo
func (*TrackPublishedResponse) ProtoMessage ¶
func (*TrackPublishedResponse) ProtoMessage()
func (*TrackPublishedResponse) ProtoReflect ¶
func (x *TrackPublishedResponse) ProtoReflect() protoreflect.Message
func (*TrackPublishedResponse) Reset ¶
func (x *TrackPublishedResponse) Reset()
func (*TrackPublishedResponse) String ¶
func (x *TrackPublishedResponse) String() string
type TrackType ¶
type TrackType int32
func (TrackType) Descriptor ¶
func (TrackType) Descriptor() protoreflect.EnumDescriptor
func (TrackType) EnumDescriptor
deprecated
func (TrackType) Number ¶
func (x TrackType) Number() protoreflect.EnumNumber
func (TrackType) Type ¶
func (TrackType) Type() protoreflect.EnumType
type TrickleRequest ¶
type TrickleRequest struct {
CandidateInit string `protobuf:"bytes,1,opt,name=candidateInit,proto3" json:"candidateInit,omitempty"`
Target SignalTarget `protobuf:"varint,2,opt,name=target,proto3,enum=livekit.SignalTarget" json:"target,omitempty"`
// contains filtered or unexported fields
}
func (*TrickleRequest) Descriptor
deprecated
func (*TrickleRequest) Descriptor() ([]byte, []int)
Deprecated: Use TrickleRequest.ProtoReflect.Descriptor instead.
func (*TrickleRequest) GetCandidateInit ¶
func (x *TrickleRequest) GetCandidateInit() string
func (*TrickleRequest) GetTarget ¶
func (x *TrickleRequest) GetTarget() SignalTarget
func (*TrickleRequest) ProtoMessage ¶
func (*TrickleRequest) ProtoMessage()
func (*TrickleRequest) ProtoReflect ¶
func (x *TrickleRequest) ProtoReflect() protoreflect.Message
func (*TrickleRequest) Reset ¶
func (x *TrickleRequest) Reset()
func (*TrickleRequest) String ¶
func (x *TrickleRequest) String() string
type TwirpServer ¶
type TwirpServer interface {
http.Handler
// ServiceDescriptor returns gzipped bytes describing the .proto file that
// this service was generated from. Once unzipped, the bytes can be
// unmarshalled as a
// google.golang.org/protobuf/types/descriptorpb.FileDescriptorProto.
//
// The returned integer is the index of this particular service within that
// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
// low-level field, expected to be used for reflection.
ServiceDescriptor() ([]byte, int)
// ProtocGenTwirpVersion is the semantic version string of the version of
// twirp used to generate this file.
ProtocGenTwirpVersion() string
// PathPrefix returns the HTTP URL path prefix for all methods handled by this
// service. This can be used with an HTTP mux to route Twirp requests.
// The path prefix is in the form: "/<prefix>/<package>.<Service>/"
// that is, everything in a Twirp route except for the <Method> at the end.
PathPrefix() string
}
TwirpServer is the interface generated server structs will support: they're HTTP handlers with additional methods for accessing metadata about the service. Those accessors are a low-level API for building reflection tools. Most people can think of TwirpServers as just http.Handlers.
func NewRecordingServiceServer ¶ added in v0.6.1
func NewRecordingServiceServer(svc RecordingService, opts ...interface{}) TwirpServer
NewRecordingServiceServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).
func NewRoomServiceServer ¶
func NewRoomServiceServer(svc RoomService, opts ...interface{}) TwirpServer
NewRoomServiceServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).
type UpdateParticipantRequest ¶
type UpdateParticipantRequest struct {
Room string `protobuf:"bytes,1,opt,name=room,proto3" json:"room,omitempty"`
Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
// metadata to update. skipping updates if left empty
Metadata string `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
// set to update the participant's permissions
Permission *ParticipantPermission `protobuf:"bytes,4,opt,name=permission,proto3" json:"permission,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateParticipantRequest) Descriptor
deprecated
func (*UpdateParticipantRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateParticipantRequest.ProtoReflect.Descriptor instead.
func (*UpdateParticipantRequest) GetIdentity ¶
func (x *UpdateParticipantRequest) GetIdentity() string
func (*UpdateParticipantRequest) GetMetadata ¶
func (x *UpdateParticipantRequest) GetMetadata() string
func (*UpdateParticipantRequest) GetPermission ¶
func (x *UpdateParticipantRequest) GetPermission() *ParticipantPermission
func (*UpdateParticipantRequest) GetRoom ¶
func (x *UpdateParticipantRequest) GetRoom() string
func (*UpdateParticipantRequest) ProtoMessage ¶
func (*UpdateParticipantRequest) ProtoMessage()
func (*UpdateParticipantRequest) ProtoReflect ¶
func (x *UpdateParticipantRequest) ProtoReflect() protoreflect.Message
func (*UpdateParticipantRequest) Reset ¶
func (x *UpdateParticipantRequest) Reset()
func (*UpdateParticipantRequest) String ¶
func (x *UpdateParticipantRequest) String() string
type UpdateSubscription ¶
type UpdateSubscription struct {
TrackSids []string `protobuf:"bytes,1,rep,name=track_sids,json=trackSids,proto3" json:"track_sids,omitempty"`
Subscribe bool `protobuf:"varint,2,opt,name=subscribe,proto3" json:"subscribe,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateSubscription) Descriptor
deprecated
func (*UpdateSubscription) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSubscription.ProtoReflect.Descriptor instead.
func (*UpdateSubscription) GetSubscribe ¶
func (x *UpdateSubscription) GetSubscribe() bool
func (*UpdateSubscription) GetTrackSids ¶
func (x *UpdateSubscription) GetTrackSids() []string
func (*UpdateSubscription) ProtoMessage ¶
func (*UpdateSubscription) ProtoMessage()
func (*UpdateSubscription) ProtoReflect ¶
func (x *UpdateSubscription) ProtoReflect() protoreflect.Message
func (*UpdateSubscription) Reset ¶
func (x *UpdateSubscription) Reset()
func (*UpdateSubscription) String ¶
func (x *UpdateSubscription) String() string
type UpdateSubscriptionsRequest ¶
type UpdateSubscriptionsRequest struct {
Room string `protobuf:"bytes,1,opt,name=room,proto3" json:"room,omitempty"`
Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
// list of sids of tracks
TrackSids []string `protobuf:"bytes,3,rep,name=track_sids,json=trackSids,proto3" json:"track_sids,omitempty"`
// set to true to subscribe, false to unsubscribe from tracks
Subscribe bool `protobuf:"varint,4,opt,name=subscribe,proto3" json:"subscribe,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateSubscriptionsRequest) Descriptor
deprecated
func (*UpdateSubscriptionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSubscriptionsRequest.ProtoReflect.Descriptor instead.
func (*UpdateSubscriptionsRequest) GetIdentity ¶
func (x *UpdateSubscriptionsRequest) GetIdentity() string
func (*UpdateSubscriptionsRequest) GetRoom ¶
func (x *UpdateSubscriptionsRequest) GetRoom() string
func (*UpdateSubscriptionsRequest) GetSubscribe ¶
func (x *UpdateSubscriptionsRequest) GetSubscribe() bool
func (*UpdateSubscriptionsRequest) GetTrackSids ¶
func (x *UpdateSubscriptionsRequest) GetTrackSids() []string
func (*UpdateSubscriptionsRequest) ProtoMessage ¶
func (*UpdateSubscriptionsRequest) ProtoMessage()
func (*UpdateSubscriptionsRequest) ProtoReflect ¶
func (x *UpdateSubscriptionsRequest) ProtoReflect() protoreflect.Message
func (*UpdateSubscriptionsRequest) Reset ¶
func (x *UpdateSubscriptionsRequest) Reset()
func (*UpdateSubscriptionsRequest) String ¶
func (x *UpdateSubscriptionsRequest) String() string
type UpdateSubscriptionsResponse ¶
type UpdateSubscriptionsResponse struct {
// contains filtered or unexported fields
}
func (*UpdateSubscriptionsResponse) Descriptor
deprecated
func (*UpdateSubscriptionsResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSubscriptionsResponse.ProtoReflect.Descriptor instead.
func (*UpdateSubscriptionsResponse) ProtoMessage ¶
func (*UpdateSubscriptionsResponse) ProtoMessage()
func (*UpdateSubscriptionsResponse) ProtoReflect ¶
func (x *UpdateSubscriptionsResponse) ProtoReflect() protoreflect.Message
func (*UpdateSubscriptionsResponse) Reset ¶
func (x *UpdateSubscriptionsResponse) Reset()
func (*UpdateSubscriptionsResponse) String ¶
func (x *UpdateSubscriptionsResponse) String() string
type UpdateTrackSettings ¶
type UpdateTrackSettings struct {
TrackSids []string `protobuf:"bytes,1,rep,name=track_sids,json=trackSids,proto3" json:"track_sids,omitempty"`
Disabled bool `protobuf:"varint,3,opt,name=disabled,proto3" json:"disabled,omitempty"`
Quality VideoQuality `protobuf:"varint,4,opt,name=quality,proto3,enum=livekit.VideoQuality" json:"quality,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateTrackSettings) Descriptor
deprecated
func (*UpdateTrackSettings) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTrackSettings.ProtoReflect.Descriptor instead.
func (*UpdateTrackSettings) GetDisabled ¶
func (x *UpdateTrackSettings) GetDisabled() bool
func (*UpdateTrackSettings) GetQuality ¶
func (x *UpdateTrackSettings) GetQuality() VideoQuality
func (*UpdateTrackSettings) GetTrackSids ¶
func (x *UpdateTrackSettings) GetTrackSids() []string
func (*UpdateTrackSettings) ProtoMessage ¶
func (*UpdateTrackSettings) ProtoMessage()
func (*UpdateTrackSettings) ProtoReflect ¶
func (x *UpdateTrackSettings) ProtoReflect() protoreflect.Message
func (*UpdateTrackSettings) Reset ¶
func (x *UpdateTrackSettings) Reset()
func (*UpdateTrackSettings) String ¶
func (x *UpdateTrackSettings) String() string
type UserPacket ¶
type UserPacket struct {
// participant ID of user that sent the message
ParticipantSid string `protobuf:"bytes,1,opt,name=participant_sid,json=participantSid,proto3" json:"participant_sid,omitempty"`
// user defined payload
Payload []byte `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
// the ID of the participants who will receive the message (the message will be sent to all the people in the room if this variable is empty)
DestinationSids []string `protobuf:"bytes,3,rep,name=destination_sids,json=destinationSids,proto3" json:"destination_sids,omitempty"`
// contains filtered or unexported fields
}
func (*UserPacket) Descriptor
deprecated
func (*UserPacket) Descriptor() ([]byte, []int)
Deprecated: Use UserPacket.ProtoReflect.Descriptor instead.
func (*UserPacket) GetDestinationSids ¶
func (x *UserPacket) GetDestinationSids() []string
func (*UserPacket) GetParticipantSid ¶
func (x *UserPacket) GetParticipantSid() string
func (*UserPacket) GetPayload ¶
func (x *UserPacket) GetPayload() []byte
func (*UserPacket) ProtoMessage ¶
func (*UserPacket) ProtoMessage()
func (*UserPacket) ProtoReflect ¶
func (x *UserPacket) ProtoReflect() protoreflect.Message
func (*UserPacket) Reset ¶
func (x *UserPacket) Reset()
func (*UserPacket) String ¶
func (x *UserPacket) String() string
type VideoQuality ¶
type VideoQuality int32
const ( VideoQuality_LOW VideoQuality = 0 VideoQuality_MEDIUM VideoQuality = 1 VideoQuality_HIGH VideoQuality = 2 )
func (VideoQuality) Descriptor ¶
func (VideoQuality) Descriptor() protoreflect.EnumDescriptor
func (VideoQuality) Enum ¶
func (x VideoQuality) Enum() *VideoQuality
func (VideoQuality) EnumDescriptor
deprecated
func (VideoQuality) EnumDescriptor() ([]byte, []int)
Deprecated: Use VideoQuality.Descriptor instead.
func (VideoQuality) Number ¶
func (x VideoQuality) Number() protoreflect.EnumNumber
func (VideoQuality) String ¶
func (x VideoQuality) String() string
func (VideoQuality) Type ¶
func (VideoQuality) Type() protoreflect.EnumType