livekit

package
v0.9.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 16, 2021 License: AGPL-3.0 Imports: 19 Imported by: 0

Documentation

Overview

Package livekit is a generated twirp stub package. This code was generated with github.com/twitchtv/twirp/protoc-gen-twirp v7.1.1.

It is generated from these files:

livekit_room.proto

Index

Constants

View Source
const RoomServicePathPrefix = "/twirp/livekit.RoomService/"

RoomServicePathPrefix is a convenience constant that could used to identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, that add a "/twirp" prefix by default, and use CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html

Variables

View Source
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.

View Source
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.

View Source
var (
	SignalTarget_name = map[int32]string{
		0: "PUBLISHER",
		1: "SUBSCRIBER",
	}
	SignalTarget_value = map[string]int32{
		"PUBLISHER":  0,
		"SUBSCRIBER": 1,
	}
)

Enum value maps for SignalTarget.

View Source
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.

View Source
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.

View Source
var File_livekit_internal_proto protoreflect.FileDescriptor
View Source
var File_livekit_models_proto protoreflect.FileDescriptor
View Source
var File_livekit_room_proto protoreflect.FileDescriptor
View Source
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"`
	// 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) GetName

func (x *AddTrackRequest) GetName() string

func (*AddTrackRequest) GetType

func (x *AddTrackRequest) GetType() TrackType

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 CreateRoomRequest

type CreateRoomRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// number of seconds the room should cleanup after being empty
	EmptyTimeout    uint32 `protobuf:"varint,2,opt,name=empty_timeout,json=emptyTimeout,proto3" json:"empty_timeout,omitempty"`
	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) 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 (DataPacket_Kind) String

func (x DataPacket_Kind) String() string

func (DataPacket_Kind) Type

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 {
	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 EndSession

type EndSession struct {
	// contains filtered or unexported fields
}

func (*EndSession) Descriptor deprecated

func (*EndSession) Descriptor() ([]byte, []int)

Deprecated: Use EndSession.ProtoReflect.Descriptor instead.

func (*EndSession) ProtoMessage

func (*EndSession) ProtoMessage()

func (*EndSession) ProtoReflect

func (x *EndSession) ProtoReflect() protoreflect.Message

func (*EndSession) Reset

func (x *EndSession) Reset()

func (*EndSession) String

func (x *EndSession) String() string

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

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) Descriptor() ([]byte, []int)

Deprecated: Use ICEServer.ProtoReflect.Descriptor instead.

func (*ICEServer) GetCredential

func (x *ICEServer) GetCredential() string

func (*ICEServer) GetUrls

func (x *ICEServer) GetUrls() []string

func (*ICEServer) GetUsername

func (x *ICEServer) GetUsername() string

func (*ICEServer) ProtoMessage

func (*ICEServer) ProtoMessage()

func (*ICEServer) ProtoReflect

func (x *ICEServer) ProtoReflect() protoreflect.Message

func (*ICEServer) Reset

func (x *ICEServer) Reset()

func (*ICEServer) String

func (x *ICEServer) String() string

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 {
	// contains filtered or unexported fields
}

func (*LeaveRequest) Descriptor deprecated

func (*LeaveRequest) Descriptor() ([]byte, []int)

Deprecated: Use LeaveRequest.ProtoReflect.Descriptor instead.

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 {
	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 {
	Room     string `protobuf:"bytes,1,opt,name=room,proto3" json:"room,omitempty"`
	Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
	TrackSid string `protobuf:"bytes,3,opt,name=track_sid,json=trackSid,proto3" json:"track_sid,omitempty"`
	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 NegotiationRequest

type NegotiationRequest struct {
	// contains filtered or unexported fields
}

func (*NegotiationRequest) Descriptor deprecated

func (*NegotiationRequest) Descriptor() ([]byte, []int)

Deprecated: Use NegotiationRequest.ProtoReflect.Descriptor instead.

func (*NegotiationRequest) ProtoMessage

func (*NegotiationRequest) ProtoMessage()

func (*NegotiationRequest) ProtoReflect

func (x *NegotiationRequest) ProtoReflect() protoreflect.Message

func (*NegotiationRequest) Reset

func (x *NegotiationRequest) Reset()

func (*NegotiationRequest) String

func (x *NegotiationRequest) String() string

type Node

type Node struct {
	Id      string     `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Ip      string     `protobuf:"bytes,2,opt,name=ip,proto3" json:"ip,omitempty"`
	NumCpus uint32     `protobuf:"varint,3,opt,name=num_cpus,json=numCpus,proto3" json:"num_cpus,omitempty"`
	Stats   *NodeStats `protobuf:"bytes,4,opt,name=stats,proto3" json:"stats,omitempty"`
	// contains filtered or unexported fields
}

func (*Node) Descriptor deprecated

func (*Node) Descriptor() ([]byte, []int)

Deprecated: Use Node.ProtoReflect.Descriptor instead.

func (*Node) GetId

func (x *Node) GetId() string

func (*Node) GetIp

func (x *Node) GetIp() string

func (*Node) GetNumCpus

func (x *Node) GetNumCpus() uint32

func (*Node) GetStats

func (x *Node) GetStats() *NodeStats

func (*Node) ProtoMessage

func (*Node) ProtoMessage()

func (*Node) ProtoReflect

func (x *Node) ProtoReflect() protoreflect.Message

func (*Node) Reset

func (x *Node) Reset()

func (*Node) String

func (x *Node) String() string

type NodeStats

type NodeStats struct {

	// when server was started
	StartedAt int64 `protobuf:"varint,1,opt,name=started_at,json=startedAt,proto3" json:"started_at,omitempty"`
	// when server last reported its status
	UpdatedAt    int64  `protobuf:"varint,2,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	NumRooms     uint32 `protobuf:"varint,3,opt,name=num_rooms,json=numRooms,proto3" json:"num_rooms,omitempty"`
	NumClients   uint32 `protobuf:"varint,4,opt,name=num_clients,json=numClients,proto3" json:"num_clients,omitempty"`
	NumTracksIn  uint32 `protobuf:"varint,5,opt,name=num_tracks_in,json=numTracksIn,proto3" json:"num_tracks_in,omitempty"`
	NumTracksOut uint32 `protobuf:"varint,6,opt,name=num_tracks_out,json=numTracksOut,proto3" json:"num_tracks_out,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeStats) Descriptor deprecated

func (*NodeStats) Descriptor() ([]byte, []int)

Deprecated: Use NodeStats.ProtoReflect.Descriptor instead.

func (*NodeStats) GetNumClients

func (x *NodeStats) GetNumClients() uint32

func (*NodeStats) GetNumRooms

func (x *NodeStats) GetNumRooms() uint32

func (*NodeStats) GetNumTracksIn

func (x *NodeStats) GetNumTracksIn() uint32

func (*NodeStats) GetNumTracksOut

func (x *NodeStats) GetNumTracksOut() uint32

func (*NodeStats) GetStartedAt

func (x *NodeStats) GetStartedAt() int64

func (*NodeStats) GetUpdatedAt

func (x *NodeStats) GetUpdatedAt() int64

func (*NodeStats) ProtoMessage

func (*NodeStats) ProtoMessage()

func (*NodeStats) ProtoReflect

func (x *NodeStats) ProtoReflect() protoreflect.Message

func (*NodeStats) Reset

func (x *NodeStats) Reset()

func (*NodeStats) String

func (x *NodeStats) 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"`
	// contains filtered or unexported fields
}

func (*ParticipantInfo) Descriptor deprecated

func (*ParticipantInfo) Descriptor() ([]byte, []int)

Deprecated: Use ParticipantInfo.ProtoReflect.Descriptor instead.

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) Enum

func (ParticipantInfo_State) EnumDescriptor deprecated

func (ParticipantInfo_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use ParticipantInfo_State.Descriptor instead.

func (ParticipantInfo_State) Number

func (ParticipantInfo_State) String

func (x ParticipantInfo_State) String() string

func (ParticipantInfo_State) Type

type ParticipantPermission

type ParticipantPermission struct {
	CanSubscribe bool `protobuf:"varint,1,opt,name=can_subscribe,json=canSubscribe,proto3" json:"can_subscribe,omitempty"`
	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 RTCNodeMessage

type RTCNodeMessage struct {
	ParticipantKey string `protobuf:"bytes,1,opt,name=participant_key,json=participantKey,proto3" json:"participant_key,omitempty"`
	// Types that are assignable to Message:
	//	*RTCNodeMessage_StartSession
	//	*RTCNodeMessage_Request
	//	*RTCNodeMessage_RemoveParticipant
	//	*RTCNodeMessage_MuteTrack
	//	*RTCNodeMessage_UpdateParticipant
	//	*RTCNodeMessage_DeleteRoom
	Message isRTCNodeMessage_Message `protobuf_oneof:"message"`
	// contains filtered or unexported fields
}

message to RTC nodes

func (*RTCNodeMessage) Descriptor deprecated

func (*RTCNodeMessage) Descriptor() ([]byte, []int)

Deprecated: Use RTCNodeMessage.ProtoReflect.Descriptor instead.

func (*RTCNodeMessage) GetDeleteRoom

func (x *RTCNodeMessage) GetDeleteRoom() *DeleteRoomRequest

func (*RTCNodeMessage) GetMessage

func (m *RTCNodeMessage) GetMessage() isRTCNodeMessage_Message

func (*RTCNodeMessage) GetMuteTrack

func (x *RTCNodeMessage) GetMuteTrack() *MuteRoomTrackRequest

func (*RTCNodeMessage) GetParticipantKey

func (x *RTCNodeMessage) GetParticipantKey() string

func (*RTCNodeMessage) GetRemoveParticipant

func (x *RTCNodeMessage) GetRemoveParticipant() *RoomParticipantIdentity

func (*RTCNodeMessage) GetRequest

func (x *RTCNodeMessage) GetRequest() *SignalRequest

func (*RTCNodeMessage) GetStartSession

func (x *RTCNodeMessage) GetStartSession() *StartSession

func (*RTCNodeMessage) GetUpdateParticipant

func (x *RTCNodeMessage) GetUpdateParticipant() *UpdateParticipantRequest

func (*RTCNodeMessage) ProtoMessage

func (*RTCNodeMessage) ProtoMessage()

func (*RTCNodeMessage) ProtoReflect

func (x *RTCNodeMessage) ProtoReflect() protoreflect.Message

func (*RTCNodeMessage) Reset

func (x *RTCNodeMessage) Reset()

func (*RTCNodeMessage) String

func (x *RTCNodeMessage) String() string

type RTCNodeMessage_DeleteRoom

type RTCNodeMessage_DeleteRoom struct {
	DeleteRoom *DeleteRoomRequest `protobuf:"bytes,7,opt,name=delete_room,json=deleteRoom,proto3,oneof"`
}

type RTCNodeMessage_MuteTrack

type RTCNodeMessage_MuteTrack struct {
	MuteTrack *MuteRoomTrackRequest `protobuf:"bytes,5,opt,name=mute_track,json=muteTrack,proto3,oneof"`
}

type RTCNodeMessage_RemoveParticipant

type RTCNodeMessage_RemoveParticipant struct {
	// internal messages
	RemoveParticipant *RoomParticipantIdentity `protobuf:"bytes,4,opt,name=remove_participant,json=removeParticipant,proto3,oneof"`
}

type RTCNodeMessage_Request

type RTCNodeMessage_Request struct {
	Request *SignalRequest `protobuf:"bytes,3,opt,name=request,proto3,oneof"`
}

type RTCNodeMessage_StartSession

type RTCNodeMessage_StartSession struct {
	StartSession *StartSession `protobuf:"bytes,2,opt,name=start_session,json=startSession,proto3,oneof"`
}

type RTCNodeMessage_UpdateParticipant

type RTCNodeMessage_UpdateParticipant struct {
	UpdateParticipant *UpdateParticipantRequest `protobuf:"bytes,6,opt,name=update_participant,json=updateParticipant,proto3,oneof"`
}

type RemoveParticipant

type RemoveParticipant struct {
	ParticipantId string `protobuf:"bytes,1,opt,name=participant_id,json=participantId,proto3" json:"participant_id,omitempty"`
	// contains filtered or unexported fields
}

func (*RemoveParticipant) Descriptor deprecated

func (*RemoveParticipant) Descriptor() ([]byte, []int)

Deprecated: Use RemoveParticipant.ProtoReflect.Descriptor instead.

func (*RemoveParticipant) GetParticipantId

func (x *RemoveParticipant) GetParticipantId() string

func (*RemoveParticipant) ProtoMessage

func (*RemoveParticipant) ProtoMessage()

func (*RemoveParticipant) ProtoReflect

func (x *RemoveParticipant) ProtoReflect() protoreflect.Message

func (*RemoveParticipant) Reset

func (x *RemoveParticipant) Reset()

func (*RemoveParticipant) String

func (x *RemoveParticipant) 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 (*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"`
	// contains filtered or unexported fields
}

func (*Room) Descriptor deprecated

func (*Room) Descriptor() ([]byte, []int)

Deprecated: Use Room.ProtoReflect.Descriptor instead.

func (*Room) GetCreationTime

func (x *Room) GetCreationTime() int64

func (*Room) GetEmptyTimeout

func (x *Room) GetEmptyTimeout() uint32

func (*Room) GetMaxParticipants

func (x *Room) GetMaxParticipants() uint32

func (*Room) GetName

func (x *Room) GetName() string

func (*Room) GetSid

func (x *Room) GetSid() string

func (*Room) GetTurnPassword

func (x *Room) GetTurnPassword() string

func (*Room) ProtoMessage

func (*Room) ProtoMessage()

func (*Room) ProtoReflect

func (x *Room) ProtoReflect() protoreflect.Message

func (*Room) Reset

func (x *Room) Reset()

func (*Room) String

func (x *Room) String() string

type RoomParticipantIdentity

type RoomParticipantIdentity 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"`
	// 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 {
	// should be accessible to only internal servers, not external
	CreateRoom(context.Context, *CreateRoomRequest) (*Room, error)

	ListRooms(context.Context, *ListRoomsRequest) (*ListRoomsResponse, error)

	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, requires RoomAdmin
	MutePublishedTrack(context.Context, *MuteRoomTrackRequest) (*MuteRoomTrackResponse, error)

	// update participant metadata
	UpdateParticipant(context.Context, *UpdateParticipantRequest) (*ParticipantInfo, 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 SignalNodeMessage

type SignalNodeMessage struct {
	ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"`
	// Types that are assignable to Message:
	//	*SignalNodeMessage_Response
	//	*SignalNodeMessage_EndSession
	Message isSignalNodeMessage_Message `protobuf_oneof:"message"`
	// contains filtered or unexported fields
}

message to Signal nodes

func (*SignalNodeMessage) Descriptor deprecated

func (*SignalNodeMessage) Descriptor() ([]byte, []int)

Deprecated: Use SignalNodeMessage.ProtoReflect.Descriptor instead.

func (*SignalNodeMessage) GetConnectionId

func (x *SignalNodeMessage) GetConnectionId() string

func (*SignalNodeMessage) GetEndSession

func (x *SignalNodeMessage) GetEndSession() *EndSession

func (*SignalNodeMessage) GetMessage

func (m *SignalNodeMessage) GetMessage() isSignalNodeMessage_Message

func (*SignalNodeMessage) GetResponse

func (x *SignalNodeMessage) GetResponse() *SignalResponse

func (*SignalNodeMessage) ProtoMessage

func (*SignalNodeMessage) ProtoMessage()

func (*SignalNodeMessage) ProtoReflect

func (x *SignalNodeMessage) ProtoReflect() protoreflect.Message

func (*SignalNodeMessage) Reset

func (x *SignalNodeMessage) Reset()

func (*SignalNodeMessage) String

func (x *SignalNodeMessage) String() string

type SignalNodeMessage_EndSession

type SignalNodeMessage_EndSession struct {
	EndSession *EndSession `protobuf:"bytes,3,opt,name=end_session,json=endSession,proto3,oneof"`
}

type SignalNodeMessage_Response

type SignalNodeMessage_Response struct {
	Response *SignalResponse `protobuf:"bytes,2,opt,name=response,proto3,oneof"`
}

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
	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) 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_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) Enum

func (x SignalTarget) Enum() *SignalTarget

func (SignalTarget) EnumDescriptor deprecated

func (SignalTarget) EnumDescriptor() ([]byte, []int)

Deprecated: Use SignalTarget.Descriptor instead.

func (SignalTarget) Number

func (SignalTarget) String

func (x SignalTarget) String() string

func (SignalTarget) Type

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 StartSession

type StartSession struct {
	RoomName     string `protobuf:"bytes,1,opt,name=room_name,json=roomName,proto3" json:"room_name,omitempty"`
	Identity     string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
	ConnectionId string `protobuf:"bytes,3,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"`
	// if a client is reconnecting (i.e. resume instead of restart)
	Reconnect bool `protobuf:"varint,4,opt,name=reconnect,proto3" json:"reconnect,omitempty"`
	// metadata to pass to participant
	Metadata        string                 `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"`
	Permission      *ParticipantPermission `protobuf:"bytes,6,opt,name=permission,proto3" json:"permission,omitempty"`
	ProtocolVersion int32                  `protobuf:"varint,7,opt,name=protocol_version,json=protocolVersion,proto3" json:"protocol_version,omitempty"`
	UsePlanB        bool                   `protobuf:"varint,8,opt,name=use_plan_b,json=usePlanB,proto3" json:"use_plan_b,omitempty"`
	// contains filtered or unexported fields
}

func (*StartSession) Descriptor deprecated

func (*StartSession) Descriptor() ([]byte, []int)

Deprecated: Use StartSession.ProtoReflect.Descriptor instead.

func (*StartSession) GetConnectionId

func (x *StartSession) GetConnectionId() string

func (*StartSession) GetIdentity

func (x *StartSession) GetIdentity() string

func (*StartSession) GetMetadata

func (x *StartSession) GetMetadata() string

func (*StartSession) GetPermission

func (x *StartSession) GetPermission() *ParticipantPermission

func (*StartSession) GetProtocolVersion

func (x *StartSession) GetProtocolVersion() int32

func (*StartSession) GetReconnect

func (x *StartSession) GetReconnect() bool

func (*StartSession) GetRoomName

func (x *StartSession) GetRoomName() string

func (*StartSession) GetUsePlanB

func (x *StartSession) GetUsePlanB() bool

func (*StartSession) ProtoMessage

func (*StartSession) ProtoMessage()

func (*StartSession) ProtoReflect

func (x *StartSession) ProtoReflect() protoreflect.Message

func (*StartSession) Reset

func (x *StartSession) Reset()

func (*StartSession) String

func (x *StartSession) String() string

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"`
	// contains filtered or unexported fields
}

func (*TrackInfo) Descriptor deprecated

func (*TrackInfo) Descriptor() ([]byte, []int)

Deprecated: Use TrackInfo.ProtoReflect.Descriptor instead.

func (*TrackInfo) GetMuted

func (x *TrackInfo) GetMuted() bool

func (*TrackInfo) GetName

func (x *TrackInfo) GetName() string

func (*TrackInfo) GetSid

func (x *TrackInfo) GetSid() string

func (*TrackInfo) GetType

func (x *TrackInfo) GetType() TrackType

func (*TrackInfo) ProtoMessage

func (*TrackInfo) ProtoMessage()

func (*TrackInfo) ProtoReflect

func (x *TrackInfo) ProtoReflect() protoreflect.Message

func (*TrackInfo) Reset

func (x *TrackInfo) Reset()

func (*TrackInfo) String

func (x *TrackInfo) String() string

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
const (
	TrackType_AUDIO TrackType = 0
	TrackType_VIDEO TrackType = 1
	TrackType_DATA  TrackType = 2
)

func (TrackType) Descriptor

func (TrackType) Descriptor() protoreflect.EnumDescriptor

func (TrackType) Enum

func (x TrackType) Enum() *TrackType

func (TrackType) EnumDescriptor deprecated

func (TrackType) EnumDescriptor() ([]byte, []int)

Deprecated: Use TrackType.Descriptor instead.

func (TrackType) Number

func (x TrackType) Number() protoreflect.EnumNumber

func (TrackType) String

func (x TrackType) String() string

func (TrackType) Type

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
	// github.com/golang/protobuf/protoc-gen-go/descriptor.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 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   string                 `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	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"`
	Quality   VideoQuality `protobuf:"varint,4,opt,name=quality,proto3,enum=livekit.VideoQuality" json:"quality,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateSubscription) Descriptor deprecated

func (*UpdateSubscription) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSubscription.ProtoReflect.Descriptor instead.

func (*UpdateSubscription) GetQuality

func (x *UpdateSubscription) GetQuality() VideoQuality

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 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"`
	// contains filtered or unexported fields
}

func (*UserPacket) Descriptor deprecated

func (*UserPacket) Descriptor() ([]byte, []int)

Deprecated: Use UserPacket.ProtoReflect.Descriptor instead.

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) Enum

func (x VideoQuality) Enum() *VideoQuality

func (VideoQuality) EnumDescriptor deprecated

func (VideoQuality) EnumDescriptor() ([]byte, []int)

Deprecated: Use VideoQuality.Descriptor instead.

func (VideoQuality) Number

func (VideoQuality) String

func (x VideoQuality) String() string

func (VideoQuality) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL