mod_bigbluebuttonbn\meeting Class Reference

Class to describe a BBB Meeting. More...

Public Member Functions
	__construct (instance $instance)
	Constructor for the meeting object.
	can_join ()
	Can the meeting be joined ?
	create_meeting ()
	Creates a bigbluebutton meeting, send the message to BBB and returns the response in an array.
	end_meeting ()
	Send an end meeting message to BBB server.
	get_attendees ()
	Get meeting attendees.
	get_guest_join_url (string $userfullname)
	Get meeting join URL for guest.
	get_join_url ()
	Get meeting join URL.
	get_meeting_info ()
	Get currently stored meeting info.
	get_participant_count ()
	Total number of moderators and viewers.
	guest_join (int $origin, string $userfullname)
	Join a meeting as a guest.
	is_running ()
	Is meeting running ?
	join (int $origin)
	Join a meeting.
	update_cache ()
	Force update the meeting in cache.

Static Public Member Functions
static	get_meeting_info_for_instance (instance $instance, bool $updatecache=false)
	Return meeting information for the specified instance.
static	get_unique_meetingid_seed ()
	Helper function returns a sha1 encoded string that is unique and will be used as a seed for meetingid.
static	join_meeting (instance $instance, $origin=logger::ORIGIN_BASE)
	Helper to join a meeting.
static	meeting_events (instance $instance, object $data)
	Helper for responding when storing live meeting events is requested.

Public Attributes
const	LOCK_SETTINGS_MEETING_DATA
	Conversion between form settings and lockSettings as set in BBB API.

Protected Member Functions
	create_meeting_data ()
	Helper to prepare data used for create meeting.
	create_meeting_metadata ()
	Helper for preparing metadata used while creating the meeting.
	do_get_meeting_info (bool $updatecache=false)
	Return meeting information for this meeting.
	get_status_message (object $meetinginfo, instance $instance)
	Deduce status message from the current meeting info and the instance.
	prepare_meeting_join_action (int $origin)
	Prepare join meeting action.

Static Protected Member Functions
static	process_meeting_events (instance $instance, stdClass $jsonobj)
	Helper function enqueues list of meeting events to be stored and processed as for completion.
static	retrieve_cached_meeting_info (instance $instance, $updatecache=false)
	Gets a meeting info object cached or fetched from the live session.

Protected Attributes
instance	$instance
	The bbb instance.
stdClass	$meetinginfo = null
	Info about the meeting.

Detailed Description

Class to describe a BBB Meeting.

Copyright

2021 Andrew Lyons andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

mod_bigbluebuttonbn\meeting::__construct

(

instance

$instance

)

Constructor for the meeting object.

Parameters

instance

$instance

Member Function Documentation

can_join()

mod_bigbluebuttonbn\meeting::can_join

(

)

Can the meeting be joined ?

Return values

bool

create_meeting()

mod_bigbluebuttonbn\meeting::create_meeting

(

)

Creates a bigbluebutton meeting, send the message to BBB and returns the response in an array.

Return values

array

create_meeting_data()

mod_bigbluebuttonbn\meeting::create_meeting_data ( )

protected

Helper to prepare data used for create meeting.

Todo

moderatorPW and attendeePW will be removed from create after release of BBB v2.6.

Return values

array

create_meeting_metadata()

mod_bigbluebuttonbn\meeting::create_meeting_metadata ( )

protected

Helper for preparing metadata used while creating the meeting.

Return values

array

do_get_meeting_info()

mod_bigbluebuttonbn\meeting::do_get_meeting_info ( bool $updatecache = false )

protected

Return meeting information for this meeting.

Parameters

bool

$updatecache

Whether to update the cache when fetching the information

Return values

stdClass

get_attendees()

mod_bigbluebuttonbn\meeting::get_attendees

(

)

Get meeting attendees.

Return values

array[]

get_guest_join_url()

mod_bigbluebuttonbn\meeting::get_guest_join_url

(

string

$userfullname

)

Get meeting join URL for guest.

Parameters

string

$userfullname

Return values

string

get_join_url()

mod_bigbluebuttonbn\meeting::get_join_url

(

)

Get meeting join URL.

Return values

string

get_meeting_info()

mod_bigbluebuttonbn\meeting::get_meeting_info

(

)

Get currently stored meeting info.

Return values

stdClass

get_meeting_info_for_instance()

static mod_bigbluebuttonbn\meeting::get_meeting_info_for_instance ( instance $instance, bool $updatecache = false )

static

Return meeting information for the specified instance.

Parameters

instance	$instance
bool	$updatecache	Whether to update the cache when fetching the information

Return values

stdClass

get_participant_count()

mod_bigbluebuttonbn\meeting::get_participant_count

(

)

Total number of moderators and viewers.

Return values

int

get_status_message()

mod_bigbluebuttonbn\meeting::get_status_message ( object $meetinginfo, instance $instance )

protected

Deduce status message from the current meeting info and the instance.

Returns the human-readable message depending on if the user must wait to join, the meeting has not yet started ...

Parameters

object	$meetinginfo
instance	$instance

Return values

string

get_unique_meetingid_seed()

static mod_bigbluebuttonbn\meeting::get_unique_meetingid_seed ( )

static

Helper function returns a sha1 encoded string that is unique and will be used as a seed for meetingid.

Return values

string

guest_join()

mod_bigbluebuttonbn\meeting::guest_join	(	int	$origin,
		string	$userfullname )

Join a meeting as a guest.

Parameters

int	$origin	The spec
string	$userfullname	Fullname for the guest user

Return values

string

The URL to redirect to

Exceptions

meeting_join_exception

is_running()

mod_bigbluebuttonbn\meeting::is_running

(

)

Is meeting running ?

Return values

bool

join()

mod_bigbluebuttonbn\meeting::join

(

int

$origin

)

Join a meeting.

Parameters

int

$origin

The spec

Return values

string

The URL to redirect to

Exceptions

meeting_join_exception

join_meeting()

static mod_bigbluebuttonbn\meeting::join_meeting ( instance $instance, $origin = logger::ORIGIN_BASE )

static

Helper to join a meeting.

It will create the meeting if not already created.

Parameters

instance	$instance
int	$origin

Return values

string

Exceptions

meeting_join_exception

this is sent if we cannot join (meeting full, user needs to wait...)

meeting_events()

static mod_bigbluebuttonbn\meeting::meeting_events ( instance $instance, object $data )

static

Helper for responding when storing live meeting events is requested.

The callback with a POST request includes:

• Authentication: Bearer <A JWT token containing {"exp":<TIMESTAMP>} encoded with HS512>
• Content Type: application/json
• Body:

Parameters

instance	$instance
object	$data

Return values

string

prepare_meeting_join_action()

mod_bigbluebuttonbn\meeting::prepare_meeting_join_action ( int $origin )

protected

Prepare join meeting action.

Parameters

int

$origin

Return values

void

process_meeting_events()

static mod_bigbluebuttonbn\meeting::process_meeting_events ( instance $instance, stdClass $jsonobj )

staticprotected

Helper function enqueues list of meeting events to be stored and processed as for completion.

Parameters

instance	$instance
stdClass	$jsonobj

retrieve_cached_meeting_info()

static mod_bigbluebuttonbn\meeting::retrieve_cached_meeting_info ( instance $instance, $updatecache = false )

staticprotected

Gets a meeting info object cached or fetched from the live session.

Parameters

instance	$instance
bool	$updatecache

Return values

array

Member Data Documentation

LOCK_SETTINGS_MEETING_DATA

const mod_bigbluebuttonbn\meeting::LOCK_SETTINGS_MEETING_DATA

Initial value:

= [
        'disablecam' => 'lockSettingsDisableCam',
        'disablemic' => 'lockSettingsDisableMic',
        'disableprivatechat' => 'lockSettingsDisablePrivateChat',
        'disablepublicchat' => 'lockSettingsDisablePublicChat',
        'disablenote' => 'lockSettingsDisableNote',
        'hideuserlist' => 'lockSettingsHideUserList'
    ]

Conversion between form settings and lockSettings as set in BBB API.

---

The documentation for this class was generated from the following file:

• mod/bigbluebuttonbn/classes/meeting.php