app

Documentation

Index

• func MeetingMapKey(id string) string
• func RecodingPattern() string
• func RecordingMapKey(id string) string
• type Mapper
  • func NewMapper(rdb redis.Client) Mapper
• type RedisMapper
  • func (m *RedisMapper) Add(key string, host string) error
  • func (m *RedisMapper) DeleteAll(pattern string) error
  • func (m *RedisMapper) Get(key string) (string, error)
  • func (m *RedisMapper) Remove(key string) error
• type Server
  • func NewServer(config *config.Config) *Server
  • func (s *Server) ChecksumValidation(c *gin.Context)
  • func (s *Server) Create(c *gin.Context)
  • func (s *Server) DeleteRecordings(c *gin.Context)
  • func (s *Server) End(c *gin.Context)
  • func (s *Server) GetMeetingInfo(c *gin.Context)
  • func (s *Server) GetMeetings(c *gin.Context)
  • func (s *Server) GetRecordings(c *gin.Context)
  • func (s *Server) GetRecordingsTextTracks(c *gin.Context)
  • func (s *Server) HealthCheck(c *gin.Context)
  • func (s *Server) IsMeetingRunning(c *gin.Context)
  • func (s *Server) Join(c *gin.Context)
  • func (s *Server) PublishRecordings(c *gin.Context)
  • func (s *Server) PutRecordingTextTrack(c *gin.Context)
  • func (s *Server) Routes() *[]api.EndpointGroup
  • func (s *Server) Run() error
  • func (s *Server) UpdateRecordings(c *gin.Context)

Functions

func MeetingMapKey

func MeetingMapKey(id string) string

MeetingMapKey format meetingID as a valid meeting map key

func RecodingPattern

func RecodingPattern() string

RecodingPattern is the pattern used to retrieve all the recordings

func RecordingMapKey

func RecordingMapKey(id string) string

RecordingMapKey format recordingID as a valid recording map key

Types

type Mapper

type Mapper interface {
	Add(key string, host string) error
	Get(key string) (string, error)
	Remove(key string) error
	DeleteAll(pattern string) error
}

Mapper manages BigBlueButton sessions

func NewMapper

func NewMapper(rdb redis.Client) Mapper

NewMapper creates a new Mapper

type RedisMapper

type RedisMapper struct {
	RDB *redis.Client
}

RedisMapper internally manage remote bigbluebutton session

func (*RedisMapper) Add

func (m *RedisMapper) Add(key string, host string) error

Add persist the session in the redis database

func (*RedisMapper) DeleteAll

func (m *RedisMapper) DeleteAll(pattern string) error

DeleteAll delete all keys matching the pattern

func (*RedisMapper) Get

func (m *RedisMapper) Get(key string) (string, error)

Get retrieve the session from the redis database

func (*RedisMapper) Remove

func (m *RedisMapper) Remove(key string) error

Remove remove the session from the redis database

type Server

type Server struct {
	Router          *gin.Engine
	Config          *config.Config
	InstanceManager admin.InstanceManager
	TenantManager   admin.TenantManager
	Mapper          Mapper
	Balancer        balancer.Balancer
}

Server struct represents an object containings the server router and its configuration

func NewServer

func NewServer(config *config.Config) *Server

NewServer creates a new server based on given configuration

func (*Server) ChecksumValidation

func (s *Server) ChecksumValidation(c *gin.Context)

ChecksumValidation handler validate all requests checksum and returns an error if the checksum is not int the request or if the checksum is invalid

func (*Server) Create

func (s *Server) Create(c *gin.Context)

Create handler find a server and create a meeting on balanced server.

func (*Server) DeleteRecordings

func (s *Server) DeleteRecordings(c *gin.Context)

DeleteRecordings handler delete a single recording for provided record identifier. See https://docs.bigbluebutton.org/dev/api.html#deleterecordings

func (*Server) End

func (s *Server) End(c *gin.Context)

End handler end provided session. See https://docs.bigbluebutton.org/dev/api.html#end

func (*Server) GetMeetingInfo

func (s *Server) GetMeetingInfo(c *gin.Context)

GetMeetingInfo handler get information about provided session. See https://docs.bigbluebutton.org/dev/api.html#getmeetinginfo

func (*Server) GetMeetings

func (s *Server) GetMeetings(c *gin.Context)

GetMeetings handler returns the getMeetings API. See https://docs.bigbluebutton.org/dev/api.html#getmeetings.

func (*Server) GetRecordings

func (s *Server) GetRecordings(c *gin.Context)

GetRecordings handler get recordings for provided session. See https://docs.bigbluebutton.org/dev/api.html#getrecordings

func (*Server) GetRecordingsTextTracks

func (s *Server) GetRecordingsTextTracks(c *gin.Context)

GetRecordingsTextTracks handler retrieve list of the caption/subtitle tracks for a recording. See https://docs.bigbluebutton.org/dev/api.html#getrecordingstexttracks

func (*Server) HealthCheck

func (s *Server) HealthCheck(c *gin.Context)

HealthCheck handler returns an health check response

func (*Server) IsMeetingRunning

func (s *Server) IsMeetingRunning(c *gin.Context)

IsMeetingRunning handler check if provided session is running. See https://docs.bigbluebutton.org/dev/api.html#ismeetingrunning

func (*Server) Join

func (s *Server) Join(c *gin.Context)

Join handler join provided session. See https://docs.bigbluebutton.org/dev/api.html#join

func (*Server) PublishRecordings

func (s *Server) PublishRecordings(c *gin.Context)

PublishRecordings handler publish a single recording for provided record identifier. See https://docs.bigbluebutton.org/dev/api.html#publishrecordings

func (*Server) PutRecordingTextTrack

func (s *Server) PutRecordingTextTrack(c *gin.Context)

PutRecordingTextTrack handler redirect to the right bigbluebutton instance

func (*Server) Routes

func (s *Server) Routes() *[]api.EndpointGroup

Routes returns the server routes

func (*Server) Run

func (s *Server) Run() error

Run launches the server

func (*Server) UpdateRecordings

func (s *Server) UpdateRecordings(c *gin.Context)

UpdateRecordings handler update recordings for provided record identifier. See https://docs.bigbluebutton.org/dev/api.html#updaterecordings