Session Options Object

This page describes the Options objects that Create Session and Update Session endpoints use

Since usage of Options Object is optional, none of the fields are required by default.

Options Object

Parameter	Type	Default	Description
allow_rating	boolean	true	Show 5-scale likert evaluation question at the end of the session.
preparation_time	integer	15	It allows administrators and instructors to join the session specified minutes before the planned time.
session_duration	integer	60	When the session is finished by the instructor, the session duration is also updated. If you want to store the planned session duration, you can use this option.
allow_users_stream_self_cam_mic	boolean	true	If it's set to true, the participants other than admins and instructors can open up their cameras and microphones.
hide_user_streams	boolean	false	Participants other than admins and instructors (unprivileged participants) cannot see other unprivileged participants.
enable_attendance_check	boolean	true	If it is set to true, a pop-up is displayed periodically to take attendance of (every 10 minutes) to every participant to let them click and engage. This option can be used to take attendance during session.
enable_simultaneous_interpretation	boolean	false	If this is set to true, the simultaneous interpretation module can be used.
enable_simultaneous_interpretation_for_users	boolean	false	If this is set to true, the simultaneous interpretation module can be used by all the participants.
start_active	boolean	false	By default, a Perculus session should be started by an instructor. If this is set to true, all users are sent in without waiting in the lobby.
return_url	string	null	If a valid URL is provided, the user is redirected to this URL at the end of the session. This is a useful feature for integrating Perculus into other platforms.
chat	Chat	See object	Please see the Chat object below.
duration	Duration	See object	Please see the Duration object below.

Chat Options

Parameter	Type	Default	Description
offMessageModule	boolean	false	Disable all chat messaging, including private and public messaging.
offGeneralMsging	boolean	false	Disable public messaging
offGeneralMsgLimitForUser	boolean	false	Only admins and instructors can see participants' messages
offSpecialMsging	boolean	false	Disable private messaging
offSpecialMsgToAdmin	boolean	false	Disable sending private messages to admins
offSpecialMsgToUser	boolean	false	Disable private messaging between users
offClearForReplay	boolean	false	Clear messaging history and delete all of the chat messages when the session is finished
onNewMsgSoundInAll	boolean	false	Play sound for each new message
onNewMsgNotifyInAll	boolean	false	Show browser notification for each new message

Duration Object

Parameter	Type	Default	Description
allowExtendTime	boolean	true	Allow time extension
useRemainingTime	boolean	false	Forces a session to finish at the remaining time regardless of active participation.