Skip to content

Commit

Permalink
parameters: add parameters for BBB API 2.7
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippKilian authored and liske committed Feb 16, 2024
1 parent 2c125b1 commit 58bd0c3
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
12 changes: 12 additions & 0 deletions b3lb/rest/b3lb/parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@
MODERATOR_ONLY_MESSAGE = "moderatorOnlyMessage"
MUTE_ON_START = "muteOnStart"
NOTIFY_RECORDING_IS_ON = "notifyRecordingIsOn"
PRE_UPLOADED_PRESENTATION = "preUploadedPresentation"
PRE_UPLOADED_PRESENTATION_NAME = "preUploadedPresentationName"
PRE_UPLOADED_PRESENTATION_OVERRIDE_DEFAULT = "preUploadedPresentationOverrideDefault"
PRESENTATION_UPLOAD_EXTERNAL_URL = "presentationUploadExternalUrl"
PRESENTATION_UPLOAD_EXTERNAL_DESCRIPTION = "presentationUploadExternalDescription"
Expand All @@ -76,6 +78,7 @@
# some join parameters needs settings.yml defined inputs, see
# https://github.com/bigbluebutton/bigbluebutton/blob/develop/bigbluebutton-html5/private/config/settings.yml
# for possible options
ERROR_REDIRECT_URL = "errorRedirectUrl"
EXCLUDE_FROM_DASHBOARD = "excludeFromDashboard"
ROLE = "role"
USERDATA_BBB_ASK_FOR_FEEDBACK_ON_LOGOUT = "userdata-bbb_ask_for_feedback_on_logout"
Expand All @@ -90,6 +93,7 @@
USERDATA_BBB_ENABLE_VIDEO = "userdata-bbb_enable_video"
USERDATA_BBB_FORCE_RESTORE_PRESENTATION_ON_NEW_EVENTS = "userdata-bbb_force_restore_presentation_on_new_events"
USERDATA_BBB_FORCE_LISTEN_ONLY = "userdata-bbb_force_listen_only"
USERDATA_BBB_FULL_AUDIO_BRIDGE = "userdata-bbb_fullaudio_bridge"
USERDATA_BBB_HIDE_PRESENTATION = "userdata-bbb_hide_presentation"
USERDATA_BBB_HIDE_PRESENTATION_ON_JOIN = "userdata-bbb_hide_presentation_on_join"
USERDATA_BBB_LISTEN_ONLY_MODE = "userdata-bbb_listen_only_mode"
Expand Down Expand Up @@ -146,6 +150,8 @@
MODERATOR_ONLY_MESSAGE,
MUTE_ON_START,
NOTIFY_RECORDING_IS_ON,
PRE_UPLOADED_PRESENTATION,
PRE_UPLOADED_PRESENTATION_NAME,
PRE_UPLOADED_PRESENTATION_OVERRIDE_DEFAULT,
PRESENTATION_UPLOAD_EXTERNAL_URL,
PRESENTATION_UPLOAD_EXTERNAL_DESCRIPTION,
Expand All @@ -156,6 +162,7 @@
]

PARAMETERS_JOIN = [
ERROR_REDIRECT_URL,
EXCLUDE_FROM_DASHBOARD,
ROLE,
USERDATA_BBB_ASK_FOR_FEEDBACK_ON_LOGOUT,
Expand All @@ -170,6 +177,7 @@
USERDATA_BBB_ENABLE_VIDEO,
USERDATA_BBB_FORCE_RESTORE_PRESENTATION_ON_NEW_EVENTS,
USERDATA_BBB_FORCE_LISTEN_ONLY,
USERDATA_BBB_FULL_AUDIO_BRIDGE,
USERDATA_BBB_HIDE_PRESENTATION,
USERDATA_BBB_HIDE_PRESENTATION_ON_JOIN,
USERDATA_BBB_LISTEN_ONLY_MODE,
Expand Down Expand Up @@ -228,6 +236,8 @@
MODERATOR_ONLY_MESSAGE: ANY_REGEX,
MUTE_ON_START: BOOLEAN_REGEX,
NOTIFY_RECORDING_IS_ON: BOOLEAN_REGEX,
PRE_UPLOADED_PRESENTATION: URL_REGEX,
PRE_UPLOADED_PRESENTATION_NAME: ANY_REGEX,
PRE_UPLOADED_PRESENTATION_OVERRIDE_DEFAULT: BOOLEAN_REGEX,
PRESENTATION_UPLOAD_EXTERNAL_DESCRIPTION: ANY_REGEX,
PRESENTATION_UPLOAD_EXTERNAL_URL: URL_REGEX,
Expand All @@ -237,6 +247,7 @@
WELCOME: ANY_REGEX,

# Join
ERROR_REDIRECT_URL: URL_REGEX,
EXCLUDE_FROM_DASHBOARD: BOOLEAN_REGEX,
ROLE: ROLE_REGEX,
USERDATA_BBB_ASK_FOR_FEEDBACK_ON_LOGOUT: BOOLEAN_REGEX,
Expand All @@ -251,6 +262,7 @@
USERDATA_BBB_ENABLE_VIDEO: BOOLEAN_REGEX,
USERDATA_BBB_FORCE_LISTEN_ONLY: BOOLEAN_REGEX,
USERDATA_BBB_FORCE_RESTORE_PRESENTATION_ON_NEW_EVENTS: BOOLEAN_REGEX,
USERDATA_BBB_FULL_AUDIO_BRIDGE: BOOLEAN_REGEX,
USERDATA_BBB_HIDE_PRESENTATION: BOOLEAN_REGEX,
USERDATA_BBB_HIDE_PRESENTATION_ON_JOIN: BOOLEAN_REGEX,
USERDATA_BBB_LISTEN_ONLY_MODE: BOOLEAN_REGEX,
Expand Down
18 changes: 18 additions & 0 deletions b3lb/rest/migrations/0015_alter_parameter_parameter.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Generated by Django 3.2.19 on 2023-11-03 13:51

from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
('rest', '0014_remove_clustergroup_sha_function'),
]

operations = [
migrations.AlterField(
model_name='parameter',
name='parameter',
field=models.CharField(choices=[('allowModsToUnmuteUsers', 'allowModsToUnmuteUsers'), ('allowStartStopRecording', 'allowStartStopRecording'), ('autoStartRecording', 'autoStartRecording'), ('bannerColor', 'bannerColor'), ('bannerText', 'bannerText'), ('copyright', 'copyright'), ('disabledFeatures', 'disabledFeatures'), ('disabledFeaturesExclude', 'disabledFeaturesExclude'), ('duration', 'duration'), ('endWhenNoModerator', 'endWhenNoModerator'), ('endWhenNoModeratorDelayInMinutes', 'endWhenNoModeratorDelayInMinutes'), ('groups', 'groups'), ('guestPolicy', 'guestPolicy'), ('learningDashboardCleanupDelayInMinutes', 'learningDashboardCleanupDelayInMinutes'), ('lockSettingsDisableCam', 'lockSettingsDisableCam'), ('lockSettingsDisableMic', 'lockSettingsDisableMic'), ('lockSettingsDisablePrivateChat', 'lockSettingsDisablePrivateChat'), ('lockSettingsDisablePublicChat', 'lockSettingsDisablePublicChat'), ('lockSettingsDisableNote', 'lockSettingsDisableNote'), ('lockSettingsHideViewersCursor', 'lockSettingsHideViewersCursor'), ('lockSettingsLockedLayout', 'lockSettingsLockedLayout'), ('lockSettingsLockOnJoin', 'lockSettingsLockOnJoin'), ('lockSettingsLockOnJoinConfigurable', 'lockSettingsLockOnJoinConfigurable'), ('logo', 'logo'), ('logoutURL', 'logoutURL'), ('maxParticipants', 'maxParticipants'), ('meetingCameraCap', 'meetingCameraCap'), ('meetingExpireIfNoUserJoinedInMinutes', 'meetingExpireIfNoUserJoinedInMinutes'), ('meetingExpireWhenLastUserLeftInMinutes', 'meetingExpireWhenLastUserLeftInMinutes'), ('meetingKeepEvents', 'meetingKeepEvents'), ('meetingLayout', 'meetingLayout'), ('meta_fullaudio-bridge', 'meta_fullaudio-bridge'), ('moderatorOnlyMessage', 'moderatorOnlyMessage'), ('muteOnStart', 'muteOnStart'), ('notifyRecordingIsOn', 'notifyRecordingIsOn'), ('preUploadedPresentation', 'preUploadedPresentation'), ('preUploadedPresentationName', 'preUploadedPresentationName'), ('preUploadedPresentationOverrideDefault', 'preUploadedPresentationOverrideDefault'), ('presentationUploadExternalUrl', 'presentationUploadExternalUrl'), ('presentationUploadExternalDescription', 'presentationUploadExternalDescription'), ('record', 'record'), ('recordFullDurationMedia', 'recordFullDurationMedia'), ('webcamsOnlyForModerator', 'webcamsOnlyForModerator'), ('welcome', 'welcome'), ('errorRedirectUrl', 'errorRedirectUrl'), ('excludeFromDashboard', 'excludeFromDashboard'), ('role', 'role'), ('userdata-bbb_ask_for_feedback_on_logout', 'userdata-bbb_ask_for_feedback_on_logout'), ('userdata-bbb_auto_join_audio', 'userdata-bbb_auto_join_audio'), ('userdata-bbb_auto_share_webcam', 'userdata-bbb_auto_share_webcam'), ('userdata-bbb_auto_swap_layout', 'userdata-bbb_auto_swap_layout'), ('userdata-bbb_client_title', 'userdata-bbb_client_title'), ('userdata-bbb_custom_style', 'userdata-bbb_custom_style'), ('userdata-bbb_custom_style_url', 'userdata-bbb_custom_style_url'), ('userdata-bbb_display_branding_area', 'userdata-bbb_display_branding_area'), ('userdata-bbb_enable_screen_sharing', 'userdata-bbb_enable_screen_sharing'), ('userdata-bbb_enable_video', 'userdata-bbb_enable_video'), ('userdata-bbb_force_restore_presentation_on_new_events', 'userdata-bbb_force_restore_presentation_on_new_events'), ('userdata-bbb_force_listen_only', 'userdata-bbb_force_listen_only'), ('userdata-bbb_fullaudio_bridge', 'userdata-bbb_fullaudio_bridge'), ('userdata-bbb_hide_presentation', 'userdata-bbb_hide_presentation'), ('userdata-bbb_hide_presentation_on_join', 'userdata-bbb_hide_presentation_on_join'), ('userdata-bbb_listen_only_mode', 'userdata-bbb_listen_only_mode'), ('userdata-bbb_mirror_own_webcam', 'userdata-bbb_mirror_own_webcam'), ('userdata-bbb_multi_user_pen_only', 'userdata-bbb_multi_user_pen_only'), ('userdata-bbb_multi_user_tools', 'userdata-bbb_multi_user_tools'), ('userdata-bbb_override_default_locale', 'userdata-bbb_override_default_locale'), ('userdata-bbb_preferred_camera_profile', 'userdata-bbb_preferred_camera_profile'), ('userdata-bbb_presenter_tools', 'userdata-bbb_presenter_tools'), ('userdata-bbb_record_video', 'userdata-bbb_record_video'), ('userdata-bbb_shortcuts', 'userdata-bbb_shortcuts'), ('userdata-bbb_show_participants_on_login', 'userdata-bbb_show_participants_on_login'), ('userdata-bbb_show_public_chat_on_login', 'userdata-bbb_show_public_chat_on_login'), ('userdata-bbb_skip_check_audio', 'userdata-bbb_skip_check_audio'), ('userdata-bbb_skip_check_audio_on_first_join', 'userdata-bbb_skip_check_audio_on_first_join'), ('userdata-bbb_skip_video_preview', 'userdata-bbb_skip_video_preview'), ('userdata-bbb_skip_video_preview_on_first_join', 'userdata-bbb_skip_video_preview_on_first_join'), ('userdata-bbb_outside_toggle_recording', 'userdata-bbb_outside_toggle_recording'), ('userdata-bbb_outside_toggle_self_voice', 'userdata-bbb_outside_toggle_self_voice')], max_length=64),
),
]

0 comments on commit 58bd0c3

Please sign in to comment.