signaling

Documentation

Index

• Constants
• type CandidatesGatheringFinished
• type Config
• type Hangup
• type IceCandidates
• type MatrixClient
  • func NewMatrixClient(config Config) *MatrixClient
  • func (m *MatrixClient) CreateForConference(conferenceID string) *MatrixForConference
  • func (m *MatrixClient) RunSync(callback func(*event.Event)) error
• type MatrixForConference
  • func (m *MatrixForConference) DeviceID() id.DeviceID
  • func (m *MatrixForConference) SendMessage(message MatrixMessage) error
• type MatrixMessage
• type MatrixRecipient
• type MatrixSignaler
• type SdpAnswer

Constants

const LocalSessionID = "sfu"

Types

type CandidatesGatheringFinished

type CandidatesGatheringFinished struct{}

type Config

type Config struct {
	// The Matrix ID (MXID) of the SFU.
	UserID id.UserID `yaml:"userId"`
	// The ULR of the homeserver that SFU talks to.
	HomeserverURL string `yaml:"homeserverUrl"`
	// The access token for the Matrix SDK.
	AccessToken string `yaml:"accessToken"`
}

Configuration for the Matrix client.

type Hangup

type Hangup struct {
	Reason event.CallHangupReason
}

type IceCandidates

type IceCandidates struct {
	Candidates []event.CallCandidate
}

type MatrixClient

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

func NewMatrixClient

func NewMatrixClient(config Config) *MatrixClient

func (*MatrixClient) CreateForConference

func (m *MatrixClient) CreateForConference(conferenceID string) *MatrixForConference

Create a new Matrix client that abstracts outgoing Matrix messages from a given conference.

func (*MatrixClient) RunSync

func (m *MatrixClient) RunSync(callback func(*event.Event)) error

Starts the Matrix client and connects to the homeserver, Returns only when the sync with Matrix stops or fails.

type MatrixForConference

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

Matrix client scoped for a particular conference.

func (*MatrixForConference) DeviceID

func (m *MatrixForConference) DeviceID() id.DeviceID

func (*MatrixForConference) SendMessage

func (m *MatrixForConference) SendMessage(message MatrixMessage) error

type MatrixMessage

type MatrixMessage struct {
	Recipient MatrixRecipient
	Message   interface{}
}

type MatrixRecipient

type MatrixRecipient struct {
	UserID          id.UserID
	DeviceID        id.DeviceID
	RemoteSessionID id.SessionID
	CallID          string
}

Defines the data that identifies a receiver of Matrix's to-device message.

type MatrixSignaler

type MatrixSignaler interface {
	SendMessage(MatrixMessage) error
	DeviceID() id.DeviceID
}

Interface that abstracts sending Send-to-device messages for the conference.

type SdpAnswer

type SdpAnswer struct {
	StreamMetadata event.CallSDPStreamMetadata
	SDP            string
}