You are here

function bbb_api_isMeetingRunning in BigBlueButton 7

Same name and namespace in other branches
  1. 6 includes/api-0.64.bbb.inc \bbb_api_isMeetingRunning()
  2. 6 includes/api-0.7.bbb.inc \bbb_api_isMeetingRunning()

Is meeting running (isMeetingRunning)

This call enables you to simply check on whether or not a meeting is running by looking it up with either the token or your ID.

Parameters

ARRAY $params: Associative array of additional url parameters. Components:

  • meetingToken: STRING The internal meeting token assigned by the API for this meeting when it was created.
  • meetingID: STRING If you specified a meeting ID when calling create, then you can use either the generated meeting token or your specified meeting ID to find meetings. This parameter takes your meeting ID.

@return BOOLEAN A string of either “true” or “false” that signals whether a meeting with this ID or token is currently running.

1 call to bbb_api_isMeetingRunning()
bbb_get_meeting in ./bbb.module
Return a meeting object

File

includes/api.bbb.inc, line 117
BigBlueButton - Enables universities and colleges to deliver a high-quality learning experience.

Code

function bbb_api_isMeetingRunning($params) {
  $response = bbb_api_call($params, 'isMeetingRunning');
  if (isset($response->returncode) && $response->returncode == 'SUCCESS') {
    return drupal_strtoupper($response->running) == 'TRUE' ? TRUE : FALSE;
  }
  else {
    if (isset($response->returncode)) {
      watchdog('bigbluebutton', '%message', array(
        '%message' => $response->message,
      ), WATCHDOG_ERROR);
    }
    return FALSE;
  }
}