DEV Community

Abdul Muqeet
Abdul Muqeet

Posted on • Edited on

Video SDK for Web JQuery - Meet Hour

MeetHour - JQuery Example

  1. SDK Example Link - https://github.com/v-empower/MeetHour-Web-MobileSDKs
  2. API Documentation Link - https://docs.v-empower.com/docs/MeetHour-API/

Steps to Use Meet Hour Web Jquery Example

  1. Go to meethour.io and signup for Developer or Higher plan. Currently we offer 28 days free trial.
  2. Go to the dashboard and then click on developers menu.
  3. Copy your Client ID, Client Secret and Api Key. After copying, paste each copied text to the respective constant in the source code js/constants.js
  4. On Home page Click on Get Access Token
  5. Then Try Schedule a Meeting & Join Meeting.

Run Program 

Go to Browser and open index.html
Enter fullscreen mode Exit fullscreen mode

Image description

Library Import 

   <script src="https://api.meethour.io/libs/v2.4.6/external_api.min.js?apiKey=${API_KEY}"><script>
   <script src="https://api.meethour.io/libs/v2.4.6/meethour-apis.min.js?apiKey=${API_KEY}"></script>
Enter fullscreen mode Exit fullscreen mode

API End Points Supported

  1. To Get Access Token Endpoint : => https://docs.v-empower.com/docs/MeetHour-API/a44a7d7669f91-user-login-get-access-token 
       ApiServices.login({
               grant_type, client_id, client_secret, username, password
           });
Enter fullscreen mode Exit fullscreen mode

=> You have to pass respective values in the argument section. Hence, to get desired response.

  1. To schedule a meeting: => https://docs.v-empower.com/docs/MeetHour-API/2de4b757a6312-meeting-schedule-meeting 
       ApiServices.scheduleMeeting(token: string, body: ScheduleMeetingType)

           type ScheduleMeetingType {
                   agenda?: string;
                   attend?:
                       | Array<number>
                       | Array<UserObjectType>
                       | Array<UserObjectType | number>;
                   default_recording_storage?: string;
                   duration_hr?: number;
                   duration_min?: number;
                   enable_pre_registration?: number;
                   endBy?: string;
                   end_date_time?: string;
                   end_times?: number;
                   groups?: Array<number | string>;
                   hostusers?:
                       | Array<number>
                       | Array<UserObjectType>
                       | Array<UserObjectType | number>;
                   instructions?: string;
                   is_recurring?: number;
                   is_show_portal?: number;
                   meeting_agenda?: string;
                   meeting_date: string;
                   meeting_meridiem: string;
                   meeting_name: string;
                   meeting_time: string;
                   meeting_topic?: string;
                   monthlyBy?: string;
                   monthlyByDay?: string;
                   monthlyByWeekday?: string;
                   monthlyByWeekdayIndex?: string;
                   options?: Array<string>;
                   passcode: string;
                   recurring_type?: string;
                   repeat_interval?: number;
                   send_calendar_invite?: number;
                   timezone: string;
                   weeklyWeekDays?: number;
               };


       type UserObjectType {
               email?: string;
               first_name?: string;
               last_name?: string;
           }
Enter fullscreen mode Exit fullscreen mode
  1. To Generate JWT Token Endpoint => https://docs.v-empower.com/docs/MeetHour-API/b7e3d0ab3906f-generate-jwt 
       ApiServices.generateJwt(token: string, body: GenerateJwtType)

      type GenerateJwtType {
               config?: {
               disableDeepLinking?: string;
               dropboxappKey?: string;
               dropboxredirectURI?: string;
               enableClosePage?: string;
               enableWelcomePage?: string;
               fileRecordingsEnabled?: boolean;
               liveStreamingEnabled?: boolean;
               p2penabled?: boolean;
               requireDisplayName?: string;
               resolution?: number;
               startAudioMuted?: number;
               videoheightideal?: number;
               videoheightmax?: number;
               videoheightmin?: number;
               videowidthideal?: number;
               videowidthmax?: number;
               videowidthmin?: number;
               };
               contact_id?: number;
               meeting_id: string;
               ui_config?: {
               ANDROID_APP_PACKAGE?: string;
               APP_NAME?: string;
               APP_SCHEME?: string;
               BRAND_WATERMARK_BACKGROUND?: string;
               DEFAULT_LOGO_URL?: string;
               ENABLE_MOBILE_BROWSER?: string;
               HIDE_DEEP_LINKING_LOGO?: string;
               MEET_HOUR_WATERMARK_LINK?: string;
               MOBILE_APP_PROMO?: string;
               MOBILE_DOWNLOAD_LINK_ANDROID?: string;
               MOBILE_DOWNLOAD_LINK_IOS?: string;
               NATIVE_APP_NAME?: string;
               PROVIDER_NAME?: string;
               SHOW_MEET_HOUR_WATERMARK?: string;
               disablePrejoinFooter?: string;
               disablePrejoinHeader?: string;
               toolbar_buttons?: Array<string>;
               };
           };
Enter fullscreen mode Exit fullscreen mode
  1. To fetch User Details: => https://docs.v-empower.com/docs/MeetHour-API/ff9d0e37d9191-user-details 
       ApiServices.userDetails(token: string)
Enter fullscreen mode Exit fullscreen mode
  1. To fetch access Token using Refresh Token: => https://docs.v-empower.com/docs/MeetHour-API/d851be1af9804-get-access-token-using-refresh-token 
       ApiServices.getRefreshToken(token: string, body: RefreshTokenType)

       type RefreshTokenType {
               client_id: string;
               client_secret: string;
               grant_type: string;
               refresh_token: string;
       }
Enter fullscreen mode Exit fullscreen mode
  1. To add a contact in Meet Hour database: => https://docs.v-empower.com/docs/MeetHour-API/bd1e416413e8c-add-contact 
       ApiServices.addContact(token: string, body: AddContactType)

       type AddContactType {
               country_code?: string;
               email: string;
               firstname: string;
               image?: string;
               is_show_portal?: boolean;
               lastname?: string;
               phone?: string;
           }
Enter fullscreen mode Exit fullscreen mode
  1. To get Timezones of various countries: => https://docs.v-empower.com/docs/MeetHour-API/c688c29bce9b9-timezone-list 
       ApiServices.timezone(token: string)
Enter fullscreen mode Exit fullscreen mode
  1. To get list of all the contacts in your Meet Hour account: => https://api.meethour.io/api/{version}/customer/contacts 
       ApiServices.contactsList(token: string, body: ContactsType)

       type ContactsType {
               exclude_hosts: number;
               limit: number;
               page: number;
           }
Enter fullscreen mode Exit fullscreen mode
  1. To make changes in the existing contact details: => https://docs.v-empower.com/docs/MeetHour-API/28cae9187d215-edit-contact 
    ApiServices.editContact(token: string, body: EditContactType)

    type EditContactType {
            contact_id: number;
            country_code: string;
            email: string;
            firstname: string;
            image: string;
            is_show_portal: boolean;
            lastname: string;
            phone: string;
        }

    ```
Enter fullscreen mode Exit fullscreen mode

  1. To get Upcoming Meetings: => https://docs.v-empower.com/docs/MeetHour-API/31df88388416d-upcoming-meetings

    

    ApiServices.upcomingMeetings(token: string, body: {
        limit: number;
        page: number;
    })

  2. To archive a meeting: => https://docs.v-empower.com/docs/MeetHour-API/1dd64523cc6bf-archive-meeting

    

    ApiServices.archiveMeeting(
            token: string,
            body: {
                id?: number;
        })

  3. To get the details of a missed meeting: => https://docs.v-empower.com/docs/MeetHour-API/92998e2dda102-missed-meetings

    

    ApiServices.missedMeetings(
        token: string,
        body: {
            limit: number;
            page: number;
        })

  4. To get completed meetings: => https://docs.v-empower.com/docs/MeetHour-API/aa9ef6a678250-completed-meetings

    

    ApiServices.completedMeetings(
        token: string,
        body: {
        limit: number;
        page: number;
        })

  5. To edit an existing meeting: => https://docs.v-empower.com/docs/MeetHour-API/5dedde36380b4-meeting-edit-meeting

    

    ApiServices.editMeeting(token: string, body: EditMeetingType)

    type EditMeeting {
        agenda?: string;
        attend?:
            | Array<number>
            | Array<UserObjectType>
            | Array<number & UserObjectType>;
        duration_hr?: number;
        duration_min?: number;
        enable_pre_registration?: number;
        endBy?: string;
        end_date_time?: string;
        groups?: Array<number>;
        hostusers?:
            | Array<number>
            | Array<UserObjectType>
            | Array<number & UserObjectType>;
        instructions?: string;
        is_recurring?: number;
        is_show_portal?: number;
        meeting_agenda?: string;
        meeting_date?: string;
        meeting_id: string;
        meeting_meridiem?: string;
        meeting_name?: string;
        meeting_time?: string;
        meeting_topic?: string;
        old_attend?:
            | Array<number>
            | Array<UserObjectType>
            | Array<number & UserObjectType>;
        options?: Array<string>;
        passcode?: string;
        recurring_type?: string;
        repeat_interval?: number;
        timezone?: string;
    }

    type UserObjectType {
        email?: string;
        first_name?: string;
        last_name?: string;
    }

  6. To view a meeting: => https://docs.v-empower.com/docs/MeetHour-API/7e9a0a1e0da7f-meeting-view-meeting

    

    ApiServices.viewMeeting(
        token: string,
        body: { meeting_id: string }
        )

  7. To get all the recordings list: => https://docs.v-empower.com/docs/MeetHour-API/ce7c4fd8cae7e-recording-list

    

    ApiServices.recordingsList(token: string, body: RecordingsList)

    type RecordingsList {
        filter_by: string;
        limit: number;
        page: number;
    }

Join Conference API

api = new MeetHourExternalAPI(domain, options)

  • domain: domain used to build the conference URL, 'meethour.io' for example.
  • options: object with properties - the optional arguments:
    • roomName: (required) name of the room to join.
    • apiKey: (required). You will get API key from your Developer Page - https://portal.meethour.io/customer/developers. Make sure you are on our Developer or higher plan. - https://meethour.io/#pricing
    • jwt: (required - If you to start meeting or join or moderator) - https://docs.v-empower.com/docs/MeetHour-API/b3A6MzcwODk5MTQ-generate-jwt
    • pcode: (optional) Pass encrypted Meeting Password dynamically. Get this from API.
    • width: (optional) width for the iframe which will be created. If a number is specified it's treated as pixel units. If a string is specified the format is number followed by 'px', 'em', 'pt' or '%'.
    • height: (optional) height for the iframe which will be created. If a number is specified it's treated as pixel units. If a string is specified the format is number followed by 'px', 'em', 'pt' or '%'.
    • parentNode: (optional) HTML DOM Element where the iframe will be added as a child.
    • noSSL: (optional, defaults to true) Boolean indicating if the server should be contacted using HTTP or HTTPS.
    • onload: (optional) handler for the iframe onload event.
    • invitees: (optional) Array of objects containing information about new participants that will be invited in the call.
    • devices: (optional) A map containing information about the initial devices that will be used in the call.
    • userInfo: (optional) JS object containing information about the participant opening the meeting, such as email.

Example:


javascript
const domain = 'meethour.io';
const options = {
    roomName: 'TestRoom',
    width: 700,
    height: 700,
    parentNode: document.querySelector('#meet')
};
const api = new MeetHourExternalAPI(domain, options);
Enter fullscreen mode Exit fullscreen mode

You can set the initial media devices for the call:


javascript
const domain = 'meethour.io';
const options = {
    ...
    devices: {
        audioInput: '<deviceLabel>',
        audioOutput: '<deviceLabel>',
        videoInput: '<deviceLabel>'
    },
    ...
};
const api = new MeetHourExternalAPI(domain, options);
Enter fullscreen mode Exit fullscreen mode

You can overwrite options set in [config.js] and [interface_config.js].
For example, to enable the filmstrip-only interface mode, you can use:


javascript
const options = {
    ...
    interfaceConfigOverwrite: { filmStripOnly: true },
    ...
};
const api = new MeetHourExternalAPI(domain, options);
Enter fullscreen mode Exit fullscreen mode

You can also pass a jwt token to Meet Hour:


javascript
const options = {
    ...
    jwt: '<jwt_token>',
    noSsl: false,
    ...
};
const api = new MeetHourExternalAPI(domain, options);
Enter fullscreen mode Exit fullscreen mode

You can set the userInfo(email, display name) for the call:


javascript
var domain = "meethour.io";
var options = {
    ...
    userInfo: {
        email: 'email@meethourexamplemail.com',
        displayName: 'John Doe'
    }
}
var api = new MeetHourExternalAPI(domain, options);
Enter fullscreen mode Exit fullscreen mode

Controlling the embedded Meet Hour Conference

Device management MeetHourExternalAPI methods:

  • getAvailableDevices - Retrieve a list of available devices.

javascript
api.getAvailableDevices().then(devices => {
    devices = {
        audioInput: [{
            deviceId: 'ID'
            groupId: 'grpID'
            kind: 'audioinput'
            label: 'label'
        },....],
        audioOutput: [{
            deviceId: 'ID'
            groupId: 'grpID'
            kind: 'audioOutput'
            label: 'label'
        },....],
        videoInput: [{
            deviceId: 'ID'
            groupId: 'grpID'
            kind: 'videoInput'
            label: 'label'
        },....]
    }
    ...
});
Enter fullscreen mode Exit fullscreen mode
  • getCurrentDevices - Retrieve a list with the devices that are currently selected.

javascript
api.getCurrentDevices().then(devices => {
    devices = {
        audioInput: {
            deviceId: 'ID'
            groupId: 'grpID'
            kind: 'videoInput'
            label: 'label'
        },
        audioOutput: {
            deviceId: 'ID'
            groupId: 'grpID'
            kind: 'videoInput'
            label: 'label'
        },
        videoInput: {
            deviceId: 'ID'
            groupId: 'grpID'
            kind: 'videoInput'
            label: 'label'
        }
    }
    ...
});
Enter fullscreen mode Exit fullscreen mode
  • isDeviceChangeAvailable - Resolves with true if the device change is available and with false if not.

javascript
// The accepted deviceType values are - 'output', 'input' or undefined.
api.isDeviceChangeAvailable(deviceType).then(isDeviceChangeAvailable => {
    ...
});
Enter fullscreen mode Exit fullscreen mode
  • isDeviceListAvailable - Resolves with true if the device list is available and with false if not.

javascript
api.isDeviceListAvailable().then(isDeviceListAvailable => {
    ...
});
Enter fullscreen mode Exit fullscreen mode
  • isMultipleAudioInputSupported - Resolves with true if multiple audio input is supported and with false if not.

javascript
api.isMultipleAudioInputSupported().then(isMultipleAudioInputSupported => {
    ...
});
Enter fullscreen mode Exit fullscreen mode
  • setAudioInputDevice - Sets the audio input device to the one with the label or id that is passed.

javascript
api.setAudioInputDevice(deviceLabel, deviceId);
Enter fullscreen mode Exit fullscreen mode
  • setAudioOutputDevice - Sets the audio output device to the one with the label or id that is passed.

javascript
api.setAudioOutputDevice(deviceLabel, deviceId);
Enter fullscreen mode Exit fullscreen mode
  • setVideoInputDevice - Sets the video input device to the one with the label or id that is passed.

javascript
api.setVideoInputDevice(deviceLabel, deviceId);
Enter fullscreen mode Exit fullscreen mode

You can control the embedded Meet Hour conference using the MeetHourExternalAPI object by using executeCommand:


javascript
api.executeCommand(command, ...arguments);
Enter fullscreen mode Exit fullscreen mode

The command parameter is String object with the name of the command. The following commands are currently supported:

  • displayName - Sets the display name of the local participant. This command requires one argument - the new display name to be set. ``` javascript api.executeCommand('displayName', 'New Nickname'); 

* **password** - Sets the password for the room. This command requires one argument - the password name to be set.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('password', 'The Password');


* **sendTones** - Play touch tones.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('sendTones', {
tones: string, // The dial pad touch tones to play. For example, '12345#'.
duration: number, // Optional. The number of milliseconds each tone should play. The default is 200.
pause: number // Optional. The number of milliseconds between each tone. The default is 200.
});


* **subject** - Sets the subject of the conference. This command requires one argument - the new subject to be set.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('subject', 'New Conference Subject');


* **toggleAudio** - Mutes / unmutes the audio for the local participant. No arguments are required.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('toggleAudio');


* **toggleVideo** - Mutes / unmutes the video for the local participant. No arguments are required.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('toggleVideo');


* **toggleFilmStrip** - Hides / shows the filmstrip. No arguments are required.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('toggleFilmStrip');


* **toggleChat** - Hides / shows the chat. No arguments are required.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('toggleChat');


* **toggleShareScreen** - Starts / stops screen sharing. No arguments are required.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('toggleShareScreen');


* **toggleTileView** - Enter / exit tile view layout mode. No arguments are required.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('toggleTileView');


* **hangup** - Hangups the call. No arguments are required.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('hangup');


* **email** - Changes the local email address. This command requires one argument - the new email address to be set.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('email', 'example@example.com');


* **avatarUrl** - Changes the local avatar URL. This command requires one argument - the new avatar URL to be set.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('avatarUrl', 'https://avatars0.githubusercontent.com/u/3671647');


* **sendEndpointTextMessage** - Sends a text message to another participant through the datachannels.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('receiverParticipantId', 'text');

* **setVideoQuality** - Sets the send and receive video resolution. This command requires one argument - the resolution height to be set.
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommand('setVideoQuality', 720);


You can also execute multiple commands using the `executeCommands` method:
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommands(commands);

The `commands` parameter is an object with the names of the commands as keys and the arguments for the commands as values:
Enter fullscreen mode Exit fullscreen mode


javascript
api.executeCommands({
displayName: [ 'nickname' ],
toggleAudio: []
});


You can add event listeners to the embedded Meet Hour using the `addEventListener` method.
**NOTE: This method still exists but it is deprecated. MeetHourExternalAPI class extends [EventEmitter]. Use [EventEmitter] methods (`addListener` or `on`).**
Enter fullscreen mode Exit fullscreen mode


javascript
api.addEventListener(event, listener);


The `event` parameter is a String object with the name of the event.
The `listener` parameter is a Function object with one argument that will be notified when the event occurs with data related to the event.

The following events are currently supported:
* **cameraError** - event notifications about meethour-Meet having failed to access the camera. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
type: string, // A constant representing the overall type of the error.
message: string // Additional information about the error.
}


* **avatarChanged** - event notifications about avatar
changes. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
id: string, // the id of the participant that changed his avatar.
avatarURL: string // the new avatar URL.
}


* **audioAvailabilityChanged** - event notifications about audio availability status changes. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
available: boolean // new available status - boolean
}


* **audioMuteStatusChanged** - event notifications about audio mute status changes. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
muted: boolean // new muted status - boolean
}


* **endpointTextMessageReceived** - event notifications about a text message received through datachannels.
The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
senderInfo: {
jid: string, // the jid of the sender
id: string // the participant id of the sender
},
eventData: {
name: string // the name of the datachannel event: endpoint-text-message
text: string // the received text from the sender
}
}


* **micError** - event notifications about meethour-Meet having failed to access the mic. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
type: string, // A constant representing the overall type of the error.
message: string // Additional information about the error.
}


* **screenSharingStatusChanged** - receives event notifications about turning on/off the local user screen sharing. The listener will receive object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
on: boolean, //whether screen sharing is on
details: {

    // From where the screen sharing is capturing, if known. Values which are
    // passed include 'window', 'screen', 'proxy', 'device'. The value undefined
    // will be passed if the source type is unknown or screen share is off.
    sourceType: string|undefined
}
Enter fullscreen mode Exit fullscreen mode

}


* **dominantSpeakerChanged** - receives event notifications about change in the dominant speaker. The listener will receive object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
id: string //participantId of the new dominant speaker
}


* **tileViewChanged** - event notifications about tile view layout mode being entered or exited. The listener will receive object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
enabled: boolean, // whether tile view is not displayed or not
}


* **incomingMessage** - Event notifications about incoming
messages. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
from: string, // The id of the user that sent the message
nick: string, // the nickname of the user that sent the message
message: string // the text of the message
}


* **outgoingMessage** - Event notifications about outgoing
messages. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
message: string // the text of the message
}


* **displayNameChange** - event notifications about display name
changes. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
id: string, // the id of the participant that changed his display name
displayname: string // the new display name
}


* **deviceListChanged** - event notifications about device list changes. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
devices: Object // the new list of available devices.
}

NOTE: The devices object has the same format as the getAvailableDevices result format.

* **emailChange** - event notifications about email
changes. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
id: string, // the id of the participant that changed his email
email: string // the new email
}

* **feedbackSubmitted** - event notifications about conference feedback submission
Enter fullscreen mode Exit fullscreen mode


javascript
{
error: string // The error which occurred during submission, if any.
}


* **filmstripDisplayChanged** - event notifications about the visibility of the filmstrip being updated.
Enter fullscreen mode Exit fullscreen mode


javascript
{
visible: boolean // Whether or not the filmstrip is displayed or hidden.
}


* **participantJoined** - event notifications about new participants who join the room. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
id: string, // the id of the participant
displayName: string // the display name of the participant
}


* **participantKickedOut** - event notifications about a participants being removed from the room. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
kicked: {
id: string, // the id of the participant removed from the room
local: boolean // whether or not the participant is the local particiapnt
},
kicker: {
id: string // the id of the participant who kicked out the other participant
}
}


* **participantLeft** - event notifications about participants that leave the room. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
id: string // the id of the participant
}


* **participantRoleChanged** - event notification fired when the role of the local user has changed (none, moderator, participant). The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
id: string // the id of the participant
role: string // the new role of the participant
}


* **passwordRequired** - event notifications fired when failing to join a room because it has a password.



* **videoConferenceJoined** - event notifications fired when the local user has joined the video conference. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
roomName: string, // the room name of the conference
id: string, // the id of the local participant
displayName: string, // the display name of the local participant
avatarURL: string // the avatar URL of the local participant
}


* **videoConferenceLeft** - event notifications fired when the local user has left the video conference. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
roomName: string // the room name of the conference
}


* **videoAvailabilityChanged** - event notifications about video availability status changes. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
available: boolean // new available status - boolean
}


* **videoMuteStatusChanged** - event notifications about video mute status changes. The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
muted: boolean // new muted status - boolean
}


* **readyToClose** - event notification fired when Meet Hour is ready to be closed (hangup operations are completed).

* **subjectChange** - event notifications about subject of conference changes.
The listener will receive an object with the following structure:
Enter fullscreen mode Exit fullscreen mode


javascript
{
subject: string // the new subject
}


* **suspendDetected** - event notifications about detecting suspend event in host computer.

You can also add multiple event listeners by using `addEventListeners`.
This method requires one argument of type Object. The object argument must
have the names of the events as keys and the listeners of the events as values.
**NOTE: This method still exists but it is deprecated. MeetHourExternalAPI class extends [EventEmitter]. Use [EventEmitter] methods.**
Enter fullscreen mode Exit fullscreen mode


javascript
function incomingMessageListener(object)
{
// ...
}

function outgoingMessageListener(object)
{
// ...
}

api.addEventListeners({
incomingMessage: incomingMessageListener,
outgoingMessage: outgoingMessageListener
});


If you want to remove a listener you can use `removeEventListener` method with argument the name of the event.
**NOTE: This method still exists but it is deprecated. MeetHourExternalAPI class extends [EventEmitter]. Use [EventEmitter] methods( `removeListener`).**
Enter fullscreen mode Exit fullscreen mode


javascript
api.removeEventListener('incomingMessage');


If you want to remove more than one event you can use `removeEventListeners` method with an Array with the names of the events as an argument.
**NOTE: This method still exists but it is deprecated. MeetHourExternalAPI class extends [EventEmitter]. Use [EventEmitter] methods.**
Enter fullscreen mode Exit fullscreen mode


javascript
api.removeEventListeners([ 'incomingMessage', 'outgoingMessageListener' ]);


You can get the number of participants in the conference with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
const numberOfParticipants = api.getNumberOfParticipants();


You can get the avatar URL of a participant in the conference with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
const avatarURL = api.getAvatarURL(participantId);


You can get the display name of a participant in the conference with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
const displayName = api.getDisplayName(participantId);


You can get the email of a participant in the conference with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
const email = api.getEmail(participantId);


You can get the iframe HTML element where Meet Hour is loaded with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
const iframe = api.getIFrame();


You can check whether the audio is muted with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
api.isAudioMuted().then(muted => {
...
});


You can check whether the video is muted with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
api.isVideoMuted().then(muted => {
...
});


You can check whether the audio is available with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
api.isAudioAvailable().then(available => {
...
});


You can check whether the video is available with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
api.isVideoAvailable().then(available => {
...
});


You can invite new participants to the call with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
api.invite([ {...}, {...}, {...} ]).then(() => {
// success
}).catch(() => {
// failure
});

**NOTE: The format of the invitees in the array depends on the invite service used for the deployment.**

You can remove the embedded Meet Hour Conference with the following API function:
Enter fullscreen mode Exit fullscreen mode


javascript
api.dispose();
Enter fullscreen mode Exit fullscreen mode

Top comments (0)

Read next

esproc_spl profile image

How to Store Specified CSV Columns to a New File #eg77

Judy -

quocbahuynh profile image

Containerize ASP.NET Core API, Entity Framework with SQL Server, Let's Encrypt, Docker, and Nginx (Part 1)

Quoc Huynh Website -

getvm profile image

Dive Deep into OS Development with "The Little Book About OS Development"

GetVM -

rick_wilson_3dc489f0f1860 profile image

Gmail tips and tricks pt: 2 Google Drive integration

Rick Wilson -