Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type ActiveSessionGetActiveSessionParams
- type ActiveSessionGetActiveSessionResponse
- type ActiveSessionGetActiveSessionResponseData
- type ActiveSessionGetActiveSessionResponseDataStatus
- type ActiveSessionGetActiveSessionResponseDataType
- type ActiveSessionKickAllParticipantsParams
- type ActiveSessionKickAllParticipantsResponse
- type ActiveSessionKickAllParticipantsResponseData
- type ActiveSessionKickParticipantsParams
- type ActiveSessionKickParticipantsResponse
- type ActiveSessionKickParticipantsResponseData
- type ActiveSessionKickParticipantsResponseDataParticipant
- type ActiveSessionNewPollParams
- type ActiveSessionNewPollResponse
- type ActiveSessionNewPollResponseData
- type ActiveSessionNewPollResponseDataPoll
- type ActiveSessionNewPollResponseDataPollOption
- type ActiveSessionNewPollResponseDataPollOptionsVote
- type ActiveSessionService
- func (r *ActiveSessionService) GetActiveSession(ctx context.Context, appID string, meetingID string, ...) (res *ActiveSessionGetActiveSessionResponse, err error)
- func (r *ActiveSessionService) KickAllParticipants(ctx context.Context, appID string, meetingID string, ...) (res *ActiveSessionKickAllParticipantsResponse, err error)
- func (r *ActiveSessionService) KickParticipants(ctx context.Context, appID string, meetingID string, ...) (res *ActiveSessionKickParticipantsResponse, err error)
- func (r *ActiveSessionService) NewPoll(ctx context.Context, appID string, meetingID string, ...) (res *ActiveSessionNewPollResponse, err error)
- type AnalyticsGetOrgAnalyticsParams
- type AnalyticsGetOrgAnalyticsResponse
- type AnalyticsGetOrgAnalyticsResponseData
- type AnalyticsGetOrgAnalyticsResponseDataRecordingStats
- type AnalyticsGetOrgAnalyticsResponseDataRecordingStatsDayStat
- type AnalyticsGetOrgAnalyticsResponseDataSessionStats
- type AnalyticsGetOrgAnalyticsResponseDataSessionStatsDayStat
- type AnalyticsService
- type AppGetParams
- type AppGetResponse
- type AppGetResponseData
- type AppPostParams
- type AppPostResponse
- type AppPostResponseData
- type AppPostResponseDataApp
- type AppService
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ErrorDataSource
- type LivestreamGetActiveLivestreamsForLivestreamIDParams
- type LivestreamGetActiveLivestreamsForLivestreamIDResponse
- type LivestreamGetActiveLivestreamsForLivestreamIDResponseData
- type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestream
- type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus
- type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataSession
- type LivestreamGetAllLivestreamsParams
- type LivestreamGetAllLivestreamsParamsSortOrder
- type LivestreamGetAllLivestreamsParamsStatus
- type LivestreamGetAllLivestreamsResponse
- type LivestreamGetAllLivestreamsResponseData
- type LivestreamGetAllLivestreamsResponseDataPaging
- type LivestreamGetAllLivestreamsResponseDataStatus
- type LivestreamGetLivestreamAnalyticsCompleteParams
- type LivestreamGetLivestreamAnalyticsCompleteResponse
- type LivestreamGetLivestreamAnalyticsCompleteResponseData
- type LivestreamGetLivestreamSessionDetailsForSessionIDParams
- type LivestreamGetLivestreamSessionDetailsForSessionIDResponse
- type LivestreamGetLivestreamSessionDetailsForSessionIDResponseData
- type LivestreamGetLivestreamSessionForLivestreamIDParams
- type LivestreamGetLivestreamSessionForLivestreamIDResponse
- type LivestreamGetLivestreamSessionForLivestreamIDResponseData
- type LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestream
- type LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus
- type LivestreamGetLivestreamSessionForLivestreamIDResponseDataPaging
- type LivestreamGetLivestreamSessionForLivestreamIDResponseDataSession
- type LivestreamGetMeetingActiveLivestreamsParams
- type LivestreamGetMeetingActiveLivestreamsResponse
- type LivestreamGetMeetingActiveLivestreamsResponseData
- type LivestreamGetMeetingActiveLivestreamsResponseDataStatus
- type LivestreamGetOrgAnalyticsParams
- type LivestreamGetOrgAnalyticsResponse
- type LivestreamGetOrgAnalyticsResponseData
- type LivestreamGetOrgAnalyticsResponseDataRecordingStats
- type LivestreamGetOrgAnalyticsResponseDataRecordingStatsDayStat
- type LivestreamGetOrgAnalyticsResponseDataSessionStats
- type LivestreamGetOrgAnalyticsResponseDataSessionStatsDayStat
- type LivestreamNewIndependentLivestreamParams
- type LivestreamNewIndependentLivestreamResponse
- type LivestreamNewIndependentLivestreamResponseData
- type LivestreamNewIndependentLivestreamResponseDataStatus
- type LivestreamService
- func (r *LivestreamService) GetActiveLivestreamsForLivestreamID(ctx context.Context, appID string, livestreamID string, ...) (res *LivestreamGetActiveLivestreamsForLivestreamIDResponse, err error)
- func (r *LivestreamService) GetAllLivestreams(ctx context.Context, appID string, params LivestreamGetAllLivestreamsParams, ...) (res *LivestreamGetAllLivestreamsResponse, err error)
- func (r *LivestreamService) GetLivestreamAnalyticsComplete(ctx context.Context, appID string, ...) (res *LivestreamGetLivestreamAnalyticsCompleteResponse, err error)
- func (r *LivestreamService) GetLivestreamSessionDetailsForSessionID(ctx context.Context, appID string, livestreamSessionID string, ...) (res *LivestreamGetLivestreamSessionDetailsForSessionIDResponse, err error)
- func (r *LivestreamService) GetLivestreamSessionForLivestreamID(ctx context.Context, appID string, livestreamID string, ...) (res *LivestreamGetLivestreamSessionForLivestreamIDResponse, err error)
- func (r *LivestreamService) GetMeetingActiveLivestreams(ctx context.Context, appID string, meetingID string, ...) (res *LivestreamGetMeetingActiveLivestreamsResponse, err error)
- func (r *LivestreamService) GetOrgAnalytics(ctx context.Context, appID string, params LivestreamGetOrgAnalyticsParams, ...) (res *LivestreamGetOrgAnalyticsResponse, err error)
- func (r *LivestreamService) NewIndependentLivestream(ctx context.Context, appID string, ...) (res *LivestreamNewIndependentLivestreamResponse, err error)
- func (r *LivestreamService) StartLivestreamingAMeeting(ctx context.Context, appID string, meetingID string, ...) (res *LivestreamStartLivestreamingAMeetingResponse, err error)
- func (r *LivestreamService) StopLivestreamingAMeeting(ctx context.Context, appID string, meetingID string, ...) (res *LivestreamStopLivestreamingAMeetingResponse, err error)
- type LivestreamStartLivestreamingAMeetingParams
- type LivestreamStartLivestreamingAMeetingParamsVideoConfig
- type LivestreamStartLivestreamingAMeetingResponse
- type LivestreamStartLivestreamingAMeetingResponseData
- type LivestreamStartLivestreamingAMeetingResponseDataStatus
- type LivestreamStopLivestreamingAMeetingParams
- type LivestreamStopLivestreamingAMeetingResponse
- type LivestreamStopLivestreamingAMeetingResponseData
- type MeetingAddParticipantParams
- type MeetingAddParticipantResponse
- type MeetingAddParticipantResponseData
- type MeetingDeleteMeetingParticipantParams
- type MeetingDeleteMeetingParticipantResponse
- type MeetingDeleteMeetingParticipantResponseData
- type MeetingEditParticipantParams
- type MeetingEditParticipantResponse
- type MeetingEditParticipantResponseData
- type MeetingGetMeetingByIDParams
- type MeetingGetMeetingByIDResponse
- type MeetingGetMeetingByIDResponseData
- type MeetingGetMeetingByIDResponseDataAIConfig
- type MeetingGetMeetingByIDResponseDataAIConfigSummarization
- type MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType
- type MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat
- type MeetingGetMeetingByIDResponseDataAIConfigTranscription
- type MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage
- type MeetingGetMeetingByIDResponseDataRecordingConfig
- type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfig
- type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel
- type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec
- type MeetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfig
- type MeetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig
- type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfig
- type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod
- type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType
- type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfig
- type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec
- type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermark
- type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition
- type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize
- type MeetingGetMeetingByIDResponseDataStatus
- type MeetingGetMeetingParticipantParams
- type MeetingGetMeetingParticipantResponse
- type MeetingGetMeetingParticipantResponseData
- type MeetingGetMeetingParticipantsParams
- type MeetingGetMeetingParticipantsResponse
- type MeetingGetMeetingParticipantsResponseData
- type MeetingGetMeetingParticipantsResponsePaging
- type MeetingGetParams
- type MeetingGetResponse
- type MeetingGetResponseData
- type MeetingGetResponseDataStatus
- type MeetingGetResponsePaging
- type MeetingNewParams
- type MeetingNewParamsAIConfig
- type MeetingNewParamsAIConfigSummarization
- type MeetingNewParamsAIConfigSummarizationSummaryType
- type MeetingNewParamsAIConfigSummarizationTextFormat
- type MeetingNewParamsAIConfigTranscription
- type MeetingNewParamsAIConfigTranscriptionLanguage
- type MeetingNewParamsRecordingConfig
- type MeetingNewParamsRecordingConfigAudioConfig
- type MeetingNewParamsRecordingConfigAudioConfigChannel
- type MeetingNewParamsRecordingConfigAudioConfigCodec
- type MeetingNewParamsRecordingConfigLiveStreamingConfig
- type MeetingNewParamsRecordingConfigRealtimekitBucketConfig
- type MeetingNewParamsRecordingConfigStorageConfig
- type MeetingNewParamsRecordingConfigStorageConfigAuthMethod
- type MeetingNewParamsRecordingConfigStorageConfigType
- type MeetingNewParamsRecordingConfigVideoConfig
- type MeetingNewParamsRecordingConfigVideoConfigCodec
- type MeetingNewParamsRecordingConfigVideoConfigWatermark
- type MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition
- type MeetingNewParamsRecordingConfigVideoConfigWatermarkSize
- type MeetingNewResponse
- type MeetingNewResponseData
- type MeetingNewResponseDataAIConfig
- type MeetingNewResponseDataAIConfigSummarization
- type MeetingNewResponseDataAIConfigSummarizationSummaryType
- type MeetingNewResponseDataAIConfigSummarizationTextFormat
- type MeetingNewResponseDataAIConfigTranscription
- type MeetingNewResponseDataAIConfigTranscriptionLanguage
- type MeetingNewResponseDataRecordingConfig
- type MeetingNewResponseDataRecordingConfigAudioConfig
- type MeetingNewResponseDataRecordingConfigAudioConfigChannel
- type MeetingNewResponseDataRecordingConfigAudioConfigCodec
- type MeetingNewResponseDataRecordingConfigLiveStreamingConfig
- type MeetingNewResponseDataRecordingConfigRealtimekitBucketConfig
- type MeetingNewResponseDataRecordingConfigStorageConfig
- type MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod
- type MeetingNewResponseDataRecordingConfigStorageConfigType
- type MeetingNewResponseDataRecordingConfigVideoConfig
- type MeetingNewResponseDataRecordingConfigVideoConfigCodec
- type MeetingNewResponseDataRecordingConfigVideoConfigWatermark
- type MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition
- type MeetingNewResponseDataRecordingConfigVideoConfigWatermarkSize
- type MeetingNewResponseDataStatus
- type MeetingRefreshParticipantTokenParams
- type MeetingRefreshParticipantTokenResponse
- type MeetingRefreshParticipantTokenResponseData
- type MeetingReplaceMeetingByIDParams
- type MeetingReplaceMeetingByIDParamsAIConfig
- type MeetingReplaceMeetingByIDParamsAIConfigSummarization
- type MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType
- type MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat
- type MeetingReplaceMeetingByIDParamsAIConfigTranscription
- type MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage
- type MeetingReplaceMeetingByIDParamsRecordingConfig
- type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfig
- type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel
- type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec
- type MeetingReplaceMeetingByIDParamsRecordingConfigLiveStreamingConfig
- type MeetingReplaceMeetingByIDParamsRecordingConfigRealtimekitBucketConfig
- type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfig
- type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod
- type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType
- type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfig
- type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec
- type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermark
- type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition
- type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkSize
- type MeetingReplaceMeetingByIDResponse
- type MeetingReplaceMeetingByIDResponseData
- type MeetingReplaceMeetingByIDResponseDataAIConfig
- type MeetingReplaceMeetingByIDResponseDataAIConfigSummarization
- type MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType
- type MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat
- type MeetingReplaceMeetingByIDResponseDataAIConfigTranscription
- type MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage
- type MeetingReplaceMeetingByIDResponseDataRecordingConfig
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfig
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfig
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfig
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfig
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermark
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition
- type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize
- type MeetingReplaceMeetingByIDResponseDataStatus
- type MeetingService
- func (r *MeetingService) AddParticipant(ctx context.Context, appID string, meetingID string, ...) (res *MeetingAddParticipantResponse, err error)
- func (r *MeetingService) DeleteMeetingParticipant(ctx context.Context, appID string, meetingID string, participantID string, ...) (res *MeetingDeleteMeetingParticipantResponse, err error)
- func (r *MeetingService) EditParticipant(ctx context.Context, appID string, meetingID string, participantID string, ...) (res *MeetingEditParticipantResponse, err error)
- func (r *MeetingService) Get(ctx context.Context, appID string, params MeetingGetParams, ...) (res *MeetingGetResponse, err error)
- func (r *MeetingService) GetMeetingByID(ctx context.Context, appID string, meetingID string, ...) (res *MeetingGetMeetingByIDResponse, err error)
- func (r *MeetingService) GetMeetingParticipant(ctx context.Context, appID string, meetingID string, participantID string, ...) (res *MeetingGetMeetingParticipantResponse, err error)
- func (r *MeetingService) GetMeetingParticipants(ctx context.Context, appID string, meetingID string, ...) (res *MeetingGetMeetingParticipantsResponse, err error)
- func (r *MeetingService) New(ctx context.Context, appID string, params MeetingNewParams, ...) (res *MeetingNewResponse, err error)
- func (r *MeetingService) RefreshParticipantToken(ctx context.Context, appID string, meetingID string, participantID string, ...) (res *MeetingRefreshParticipantTokenResponse, err error)
- func (r *MeetingService) ReplaceMeetingByID(ctx context.Context, appID string, meetingID string, ...) (res *MeetingReplaceMeetingByIDResponse, err error)
- func (r *MeetingService) UpdateMeetingByID(ctx context.Context, appID string, meetingID string, ...) (res *MeetingUpdateMeetingByIDResponse, err error)
- type MeetingUpdateMeetingByIDParams
- type MeetingUpdateMeetingByIDParamsAIConfig
- type MeetingUpdateMeetingByIDParamsAIConfigSummarization
- type MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType
- type MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat
- type MeetingUpdateMeetingByIDParamsAIConfigTranscription
- type MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage
- type MeetingUpdateMeetingByIDParamsStatus
- type MeetingUpdateMeetingByIDResponse
- type MeetingUpdateMeetingByIDResponseData
- type MeetingUpdateMeetingByIDResponseDataAIConfig
- type MeetingUpdateMeetingByIDResponseDataAIConfigSummarization
- type MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType
- type MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat
- type MeetingUpdateMeetingByIDResponseDataAIConfigTranscription
- type MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage
- type MeetingUpdateMeetingByIDResponseDataRecordingConfig
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfig
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfig
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfig
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfig
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermark
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition
- type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize
- type MeetingUpdateMeetingByIDResponseDataStatus
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type PresetDeleteParams
- type PresetDeleteResponse
- type PresetDeleteResponseData
- type PresetDeleteResponseDataConfig
- type PresetDeleteResponseDataConfigMaxVideoStreams
- type PresetDeleteResponseDataConfigMedia
- type PresetDeleteResponseDataConfigMediaAudio
- type PresetDeleteResponseDataConfigMediaScreenshare
- type PresetDeleteResponseDataConfigMediaScreenshareQuality
- type PresetDeleteResponseDataConfigMediaVideo
- type PresetDeleteResponseDataConfigMediaVideoQuality
- type PresetDeleteResponseDataConfigViewType
- type PresetDeleteResponseDataPermissions
- type PresetDeleteResponseDataPermissionsChat
- type PresetDeleteResponseDataPermissionsChatPrivate
- type PresetDeleteResponseDataPermissionsChatPublic
- type PresetDeleteResponseDataPermissionsConnectedMeetings
- type PresetDeleteResponseDataPermissionsMedia
- type PresetDeleteResponseDataPermissionsMediaAudio
- type PresetDeleteResponseDataPermissionsMediaAudioCanProduce
- type PresetDeleteResponseDataPermissionsMediaScreenshare
- type PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce
- type PresetDeleteResponseDataPermissionsMediaVideo
- type PresetDeleteResponseDataPermissionsMediaVideoCanProduce
- type PresetDeleteResponseDataPermissionsPlugins
- type PresetDeleteResponseDataPermissionsPluginsConfigObject
- type PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl
- type PresetDeleteResponseDataPermissionsPluginsConfigUnion
- type PresetDeleteResponseDataPermissionsPolls
- type PresetDeleteResponseDataPermissionsRecorderType
- type PresetDeleteResponseDataPermissionsWaitingRoomType
- type PresetDeleteResponseDataUI
- type PresetDeleteResponseDataUIDesignTokens
- type PresetDeleteResponseDataUIDesignTokensBorderRadius
- type PresetDeleteResponseDataUIDesignTokensBorderWidth
- type PresetDeleteResponseDataUIDesignTokensColors
- type PresetDeleteResponseDataUIDesignTokensColorsBackground
- type PresetDeleteResponseDataUIDesignTokensColorsBrand
- type PresetDeleteResponseDataUIDesignTokensTheme
- type PresetGetParams
- type PresetGetPresetByIDParams
- type PresetGetPresetByIDResponse
- type PresetGetPresetByIDResponseData
- type PresetGetPresetByIDResponseDataConfig
- type PresetGetPresetByIDResponseDataConfigMaxVideoStreams
- type PresetGetPresetByIDResponseDataConfigMedia
- type PresetGetPresetByIDResponseDataConfigMediaAudio
- type PresetGetPresetByIDResponseDataConfigMediaScreenshare
- type PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality
- type PresetGetPresetByIDResponseDataConfigMediaVideo
- type PresetGetPresetByIDResponseDataConfigMediaVideoQuality
- type PresetGetPresetByIDResponseDataConfigViewType
- type PresetGetPresetByIDResponseDataPermissions
- type PresetGetPresetByIDResponseDataPermissionsChat
- type PresetGetPresetByIDResponseDataPermissionsChatPrivate
- type PresetGetPresetByIDResponseDataPermissionsChatPublic
- type PresetGetPresetByIDResponseDataPermissionsConnectedMeetings
- type PresetGetPresetByIDResponseDataPermissionsMedia
- type PresetGetPresetByIDResponseDataPermissionsMediaAudio
- type PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce
- type PresetGetPresetByIDResponseDataPermissionsMediaScreenshare
- type PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce
- type PresetGetPresetByIDResponseDataPermissionsMediaVideo
- type PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce
- type PresetGetPresetByIDResponseDataPermissionsPlugins
- type PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject
- type PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl
- type PresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion
- type PresetGetPresetByIDResponseDataPermissionsPolls
- type PresetGetPresetByIDResponseDataPermissionsRecorderType
- type PresetGetPresetByIDResponseDataPermissionsWaitingRoomType
- type PresetGetPresetByIDResponseDataUI
- type PresetGetPresetByIDResponseDataUIDesignTokens
- type PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius
- type PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth
- type PresetGetPresetByIDResponseDataUIDesignTokensColors
- type PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground
- type PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand
- type PresetGetPresetByIDResponseDataUIDesignTokensTheme
- type PresetGetResponse
- type PresetGetResponseData
- type PresetGetResponsePaging
- type PresetNewParams
- type PresetNewParamsConfig
- type PresetNewParamsConfigMaxVideoStreams
- type PresetNewParamsConfigMedia
- type PresetNewParamsConfigMediaAudio
- type PresetNewParamsConfigMediaScreenshare
- type PresetNewParamsConfigMediaScreenshareQuality
- type PresetNewParamsConfigMediaVideo
- type PresetNewParamsConfigMediaVideoQuality
- type PresetNewParamsConfigViewType
- type PresetNewParamsPermissions
- type PresetNewParamsPermissionsChat
- type PresetNewParamsPermissionsChatPrivate
- type PresetNewParamsPermissionsChatPublic
- type PresetNewParamsPermissionsConnectedMeetings
- type PresetNewParamsPermissionsMedia
- type PresetNewParamsPermissionsMediaAudio
- type PresetNewParamsPermissionsMediaAudioCanProduce
- type PresetNewParamsPermissionsMediaScreenshare
- type PresetNewParamsPermissionsMediaScreenshareCanProduce
- type PresetNewParamsPermissionsMediaVideo
- type PresetNewParamsPermissionsMediaVideoCanProduce
- type PresetNewParamsPermissionsPlugins
- type PresetNewParamsPermissionsPluginsConfigObject
- type PresetNewParamsPermissionsPluginsConfigObjectAccessControl
- type PresetNewParamsPermissionsPluginsConfigUnion
- type PresetNewParamsPermissionsPolls
- type PresetNewParamsPermissionsRecorderType
- type PresetNewParamsPermissionsWaitingRoomType
- type PresetNewParamsUI
- type PresetNewParamsUIDesignTokens
- type PresetNewParamsUIDesignTokensBorderRadius
- type PresetNewParamsUIDesignTokensBorderWidth
- type PresetNewParamsUIDesignTokensColors
- type PresetNewParamsUIDesignTokensColorsBackground
- type PresetNewParamsUIDesignTokensColorsBrand
- type PresetNewParamsUIDesignTokensTheme
- type PresetNewResponse
- type PresetNewResponseData
- type PresetNewResponseDataConfig
- type PresetNewResponseDataConfigMaxVideoStreams
- type PresetNewResponseDataConfigMedia
- type PresetNewResponseDataConfigMediaAudio
- type PresetNewResponseDataConfigMediaScreenshare
- type PresetNewResponseDataConfigMediaScreenshareQuality
- type PresetNewResponseDataConfigMediaVideo
- type PresetNewResponseDataConfigMediaVideoQuality
- type PresetNewResponseDataConfigViewType
- type PresetNewResponseDataPermissions
- type PresetNewResponseDataPermissionsChat
- type PresetNewResponseDataPermissionsChatPrivate
- type PresetNewResponseDataPermissionsChatPublic
- type PresetNewResponseDataPermissionsConnectedMeetings
- type PresetNewResponseDataPermissionsMedia
- type PresetNewResponseDataPermissionsMediaAudio
- type PresetNewResponseDataPermissionsMediaAudioCanProduce
- type PresetNewResponseDataPermissionsMediaScreenshare
- type PresetNewResponseDataPermissionsMediaScreenshareCanProduce
- type PresetNewResponseDataPermissionsMediaVideo
- type PresetNewResponseDataPermissionsMediaVideoCanProduce
- type PresetNewResponseDataPermissionsPlugins
- type PresetNewResponseDataPermissionsPluginsConfigObject
- type PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl
- type PresetNewResponseDataPermissionsPluginsConfigUnion
- type PresetNewResponseDataPermissionsPolls
- type PresetNewResponseDataPermissionsRecorderType
- type PresetNewResponseDataPermissionsWaitingRoomType
- type PresetNewResponseDataUI
- type PresetNewResponseDataUIDesignTokens
- type PresetNewResponseDataUIDesignTokensBorderRadius
- type PresetNewResponseDataUIDesignTokensBorderWidth
- type PresetNewResponseDataUIDesignTokensColors
- type PresetNewResponseDataUIDesignTokensColorsBackground
- type PresetNewResponseDataUIDesignTokensColorsBrand
- type PresetNewResponseDataUIDesignTokensTheme
- type PresetService
- func (r *PresetService) Delete(ctx context.Context, appID string, presetID string, body PresetDeleteParams, ...) (res *PresetDeleteResponse, err error)
- func (r *PresetService) Get(ctx context.Context, appID string, params PresetGetParams, ...) (res *PresetGetResponse, err error)
- func (r *PresetService) GetPresetByID(ctx context.Context, appID string, presetID string, ...) (res *PresetGetPresetByIDResponse, err error)
- func (r *PresetService) New(ctx context.Context, appID string, params PresetNewParams, ...) (res *PresetNewResponse, err error)
- func (r *PresetService) Update(ctx context.Context, appID string, presetID string, params PresetUpdateParams, ...) (res *PresetUpdateResponse, err error)
- type PresetUpdateParams
- type PresetUpdateParamsConfig
- type PresetUpdateParamsConfigMaxVideoStreams
- type PresetUpdateParamsConfigMedia
- type PresetUpdateParamsConfigMediaScreenshare
- type PresetUpdateParamsConfigMediaScreenshareQuality
- type PresetUpdateParamsConfigMediaVideo
- type PresetUpdateParamsConfigMediaVideoQuality
- type PresetUpdateParamsConfigViewType
- type PresetUpdateParamsPermissions
- type PresetUpdateParamsPermissionsChat
- type PresetUpdateParamsPermissionsChatPrivate
- type PresetUpdateParamsPermissionsChatPublic
- type PresetUpdateParamsPermissionsConnectedMeetings
- type PresetUpdateParamsPermissionsMedia
- type PresetUpdateParamsPermissionsMediaAudio
- type PresetUpdateParamsPermissionsMediaAudioCanProduce
- type PresetUpdateParamsPermissionsMediaScreenshare
- type PresetUpdateParamsPermissionsMediaScreenshareCanProduce
- type PresetUpdateParamsPermissionsMediaVideo
- type PresetUpdateParamsPermissionsMediaVideoCanProduce
- type PresetUpdateParamsPermissionsPlugins
- type PresetUpdateParamsPermissionsPluginsConfigObject
- type PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl
- type PresetUpdateParamsPermissionsPluginsConfigUnion
- type PresetUpdateParamsPermissionsPolls
- type PresetUpdateParamsPermissionsRecorderType
- type PresetUpdateParamsPermissionsWaitingRoomType
- type PresetUpdateParamsUI
- type PresetUpdateParamsUIDesignTokens
- type PresetUpdateParamsUIDesignTokensBorderRadius
- type PresetUpdateParamsUIDesignTokensBorderWidth
- type PresetUpdateParamsUIDesignTokensColors
- type PresetUpdateParamsUIDesignTokensColorsBackground
- type PresetUpdateParamsUIDesignTokensColorsBrand
- type PresetUpdateParamsUIDesignTokensTheme
- type PresetUpdateResponse
- type PresetUpdateResponseData
- type PresetUpdateResponseDataConfig
- type PresetUpdateResponseDataConfigMaxVideoStreams
- type PresetUpdateResponseDataConfigMedia
- type PresetUpdateResponseDataConfigMediaAudio
- type PresetUpdateResponseDataConfigMediaScreenshare
- type PresetUpdateResponseDataConfigMediaScreenshareQuality
- type PresetUpdateResponseDataConfigMediaVideo
- type PresetUpdateResponseDataConfigMediaVideoQuality
- type PresetUpdateResponseDataConfigViewType
- type PresetUpdateResponseDataPermissions
- type PresetUpdateResponseDataPermissionsChat
- type PresetUpdateResponseDataPermissionsChatPrivate
- type PresetUpdateResponseDataPermissionsChatPublic
- type PresetUpdateResponseDataPermissionsConnectedMeetings
- type PresetUpdateResponseDataPermissionsMedia
- type PresetUpdateResponseDataPermissionsMediaAudio
- type PresetUpdateResponseDataPermissionsMediaAudioCanProduce
- type PresetUpdateResponseDataPermissionsMediaScreenshare
- type PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce
- type PresetUpdateResponseDataPermissionsMediaVideo
- type PresetUpdateResponseDataPermissionsMediaVideoCanProduce
- type PresetUpdateResponseDataPermissionsPlugins
- type PresetUpdateResponseDataPermissionsPluginsConfigObject
- type PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl
- type PresetUpdateResponseDataPermissionsPluginsConfigUnion
- type PresetUpdateResponseDataPermissionsPolls
- type PresetUpdateResponseDataPermissionsRecorderType
- type PresetUpdateResponseDataPermissionsWaitingRoomType
- type PresetUpdateResponseDataUI
- type PresetUpdateResponseDataUIDesignTokens
- type PresetUpdateResponseDataUIDesignTokensBorderRadius
- type PresetUpdateResponseDataUIDesignTokensBorderWidth
- type PresetUpdateResponseDataUIDesignTokensColors
- type PresetUpdateResponseDataUIDesignTokensColorsBackground
- type PresetUpdateResponseDataUIDesignTokensColorsBrand
- type PresetUpdateResponseDataUIDesignTokensTheme
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type RealtimeKitService
- type RecordingGetActiveRecordingsParams
- type RecordingGetActiveRecordingsResponse
- type RecordingGetActiveRecordingsResponseData
- type RecordingGetActiveRecordingsResponseDataStatus
- type RecordingGetOneRecordingParams
- type RecordingGetOneRecordingResponse
- type RecordingGetOneRecordingResponseData
- type RecordingGetOneRecordingResponseDataStartReason
- type RecordingGetOneRecordingResponseDataStartReasonCaller
- type RecordingGetOneRecordingResponseDataStartReasonCallerType
- type RecordingGetOneRecordingResponseDataStartReasonReason
- type RecordingGetOneRecordingResponseDataStatus
- type RecordingGetOneRecordingResponseDataStopReason
- type RecordingGetOneRecordingResponseDataStopReasonCaller
- type RecordingGetOneRecordingResponseDataStopReasonCallerType
- type RecordingGetOneRecordingResponseDataStopReasonReason
- type RecordingGetOneRecordingResponseDataStorageConfig
- type RecordingGetOneRecordingResponseDataStorageConfigAuthMethod
- type RecordingGetOneRecordingResponseDataStorageConfigType
- type RecordingGetRecordingsParams
- type RecordingGetRecordingsParamsSortBy
- type RecordingGetRecordingsParamsSortOrder
- type RecordingGetRecordingsParamsStatus
- type RecordingGetRecordingsResponse
- type RecordingGetRecordingsResponseData
- type RecordingGetRecordingsResponseDataMeeting
- type RecordingGetRecordingsResponseDataMeetingStatus
- type RecordingGetRecordingsResponseDataStatus
- type RecordingGetRecordingsResponseDataStorageConfig
- type RecordingGetRecordingsResponseDataStorageConfigAuthMethod
- type RecordingGetRecordingsResponseDataStorageConfigType
- type RecordingGetRecordingsResponsePaging
- type RecordingPauseResumeStopRecordingParams
- type RecordingPauseResumeStopRecordingParamsAction
- type RecordingPauseResumeStopRecordingResponse
- type RecordingPauseResumeStopRecordingResponseData
- type RecordingPauseResumeStopRecordingResponseDataStartReason
- type RecordingPauseResumeStopRecordingResponseDataStartReasonCaller
- type RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType
- type RecordingPauseResumeStopRecordingResponseDataStartReasonReason
- type RecordingPauseResumeStopRecordingResponseDataStatus
- type RecordingPauseResumeStopRecordingResponseDataStopReason
- type RecordingPauseResumeStopRecordingResponseDataStopReasonCaller
- type RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType
- type RecordingPauseResumeStopRecordingResponseDataStopReasonReason
- type RecordingPauseResumeStopRecordingResponseDataStorageConfig
- type RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod
- type RecordingPauseResumeStopRecordingResponseDataStorageConfigType
- type RecordingService
- func (r *RecordingService) GetActiveRecordings(ctx context.Context, appID string, meetingID string, ...) (res *RecordingGetActiveRecordingsResponse, err error)
- func (r *RecordingService) GetOneRecording(ctx context.Context, appID string, recordingID string, ...) (res *RecordingGetOneRecordingResponse, err error)
- func (r *RecordingService) GetRecordings(ctx context.Context, appID string, params RecordingGetRecordingsParams, ...) (res *RecordingGetRecordingsResponse, err error)
- func (r *RecordingService) PauseResumeStopRecording(ctx context.Context, appID string, recordingID string, ...) (res *RecordingPauseResumeStopRecordingResponse, err error)
- func (r *RecordingService) StartRecordings(ctx context.Context, appID string, params RecordingStartRecordingsParams, ...) (res *RecordingStartRecordingsResponse, err error)
- func (r *RecordingService) StartTrackRecording(ctx context.Context, appID string, params RecordingStartTrackRecordingParams, ...) (err error)
- type RecordingStartRecordingsParams
- type RecordingStartRecordingsParamsAudioConfig
- type RecordingStartRecordingsParamsAudioConfigChannel
- type RecordingStartRecordingsParamsAudioConfigCodec
- type RecordingStartRecordingsParamsInteractiveConfig
- type RecordingStartRecordingsParamsInteractiveConfigType
- type RecordingStartRecordingsParamsRealtimekitBucketConfig
- type RecordingStartRecordingsParamsRtmpOutConfig
- type RecordingStartRecordingsParamsStorageConfig
- type RecordingStartRecordingsParamsStorageConfigAuthMethod
- type RecordingStartRecordingsParamsStorageConfigType
- type RecordingStartRecordingsParamsVideoConfig
- type RecordingStartRecordingsParamsVideoConfigCodec
- type RecordingStartRecordingsParamsVideoConfigWatermark
- type RecordingStartRecordingsParamsVideoConfigWatermarkPosition
- type RecordingStartRecordingsParamsVideoConfigWatermarkSize
- type RecordingStartRecordingsResponse
- type RecordingStartRecordingsResponseData
- type RecordingStartRecordingsResponseDataStartReason
- type RecordingStartRecordingsResponseDataStartReasonCaller
- type RecordingStartRecordingsResponseDataStartReasonCallerType
- type RecordingStartRecordingsResponseDataStartReasonReason
- type RecordingStartRecordingsResponseDataStatus
- type RecordingStartRecordingsResponseDataStopReason
- type RecordingStartRecordingsResponseDataStopReasonCaller
- type RecordingStartRecordingsResponseDataStopReasonCallerType
- type RecordingStartRecordingsResponseDataStopReasonReason
- type RecordingStartRecordingsResponseDataStorageConfig
- type RecordingStartRecordingsResponseDataStorageConfigAuthMethod
- type RecordingStartRecordingsResponseDataStorageConfigType
- type RecordingStartTrackRecordingParams
- type RecordingStartTrackRecordingParamsLayers
- type RecordingStartTrackRecordingParamsLayersOutput
- type RecordingStartTrackRecordingParamsLayersOutputsStorageConfig
- type RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod
- type RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType
- type RecordingStartTrackRecordingParamsLayersOutputsType
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SessionGenerateSummaryOfTranscriptsParams
- type SessionGetParticipantDataFromPeerIDParams
- type SessionGetParticipantDataFromPeerIDParamsFilters
- type SessionGetParticipantDataFromPeerIDResponse
- type SessionGetParticipantDataFromPeerIDResponseData
- type SessionGetParticipantDataFromPeerIDResponseDataParticipant
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReport
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadata
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadata
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairs
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransport
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfo
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEvent
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformation
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASN
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadata
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQuality
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducer
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulative
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLoss
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMos
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTT
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStats
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfo
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEvent
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadata
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfo
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivity
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetails
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASN
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocation
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoords
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformation
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASN
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformation
- type SessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStats
- type SessionGetSessionChatParams
- type SessionGetSessionChatResponse
- type SessionGetSessionChatResponseData
- type SessionGetSessionDetailsParams
- type SessionGetSessionDetailsResponse
- type SessionGetSessionDetailsResponseData
- type SessionGetSessionDetailsResponseDataSession
- type SessionGetSessionDetailsResponseDataSessionStatus
- type SessionGetSessionDetailsResponseDataSessionType
- type SessionGetSessionParticipantDetailsParams
- type SessionGetSessionParticipantDetailsParamsFilters
- type SessionGetSessionParticipantDetailsResponse
- type SessionGetSessionParticipantDetailsResponseData
- type SessionGetSessionParticipantDetailsResponseDataParticipant
- type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStats
- type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfo
- type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEvent
- type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformation
- type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformation
- type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStat
- type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStat
- type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStat
- type SessionGetSessionParticipantsParams
- type SessionGetSessionParticipantsParamsSortBy
- type SessionGetSessionParticipantsParamsSortOrder
- type SessionGetSessionParticipantsParamsView
- type SessionGetSessionParticipantsResponse
- type SessionGetSessionParticipantsResponseData
- type SessionGetSessionParticipantsResponseDataParticipant
- type SessionGetSessionSummaryParams
- type SessionGetSessionSummaryResponse
- type SessionGetSessionSummaryResponseData
- type SessionGetSessionTranscriptsParams
- type SessionGetSessionTranscriptsResponse
- type SessionGetSessionTranscriptsResponseData
- type SessionGetSessionsParams
- type SessionGetSessionsParamsSortBy
- type SessionGetSessionsParamsSortOrder
- type SessionGetSessionsParamsStatus
- type SessionGetSessionsResponse
- type SessionGetSessionsResponseData
- type SessionGetSessionsResponseDataSession
- type SessionGetSessionsResponseDataSessionsStatus
- type SessionGetSessionsResponseDataSessionsType
- type SessionService
- func (r *SessionService) GenerateSummaryOfTranscripts(ctx context.Context, appID string, sessionID string, ...) (err error)
- func (r *SessionService) GetParticipantDataFromPeerID(ctx context.Context, appID string, peerID string, ...) (res *SessionGetParticipantDataFromPeerIDResponse, err error)
- func (r *SessionService) GetSessionChat(ctx context.Context, appID string, sessionID string, ...) (res *SessionGetSessionChatResponse, err error)
- func (r *SessionService) GetSessionDetails(ctx context.Context, appID string, sessionID string, ...) (res *SessionGetSessionDetailsResponse, err error)
- func (r *SessionService) GetSessionParticipantDetails(ctx context.Context, appID string, sessionID string, participantID string, ...) (res *SessionGetSessionParticipantDetailsResponse, err error)
- func (r *SessionService) GetSessionParticipants(ctx context.Context, appID string, sessionID string, ...) (res *SessionGetSessionParticipantsResponse, err error)
- func (r *SessionService) GetSessionSummary(ctx context.Context, appID string, sessionID string, ...) (res *SessionGetSessionSummaryResponse, err error)
- func (r *SessionService) GetSessionTranscripts(ctx context.Context, appID string, sessionID string, ...) (res *SessionGetSessionTranscriptsResponse, err error)
- func (r *SessionService) GetSessions(ctx context.Context, appID string, params SessionGetSessionsParams, ...) (res *SessionGetSessionsResponse, err error)
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
- type WebhookDeleteWebhookParams
- type WebhookDeleteWebhookResponse
- type WebhookDeleteWebhookResponseData
- type WebhookDeleteWebhookResponseDataEvent
- type WebhookEditWebhookParams
- type WebhookEditWebhookParamsEvent
- type WebhookEditWebhookResponse
- type WebhookEditWebhookResponseData
- type WebhookEditWebhookResponseDataEvent
- type WebhookGetWebhookByIDParams
- type WebhookGetWebhookByIDResponse
- type WebhookGetWebhookByIDResponseData
- type WebhookGetWebhookByIDResponseDataEvent
- type WebhookGetWebhooksParams
- type WebhookGetWebhooksResponse
- type WebhookGetWebhooksResponseData
- type WebhookGetWebhooksResponseDataEvent
- type WebhookNewWebhookParams
- type WebhookNewWebhookParamsEvent
- type WebhookNewWebhookResponse
- type WebhookNewWebhookResponseData
- type WebhookNewWebhookResponseDataEvent
- type WebhookReplaceWebhookParams
- type WebhookReplaceWebhookParamsEvent
- type WebhookReplaceWebhookResponse
- type WebhookReplaceWebhookResponseData
- type WebhookReplaceWebhookResponseDataEvent
- type WebhookService
- func (r *WebhookService) DeleteWebhook(ctx context.Context, appID string, webhookID string, ...) (res *WebhookDeleteWebhookResponse, err error)
- func (r *WebhookService) EditWebhook(ctx context.Context, appID string, webhookID string, ...) (res *WebhookEditWebhookResponse, err error)
- func (r *WebhookService) GetWebhookByID(ctx context.Context, appID string, webhookID string, ...) (res *WebhookGetWebhookByIDResponse, err error)
- func (r *WebhookService) GetWebhooks(ctx context.Context, appID string, query WebhookGetWebhooksParams, ...) (res *WebhookGetWebhooksResponse, err error)
- func (r *WebhookService) NewWebhook(ctx context.Context, appID string, params WebhookNewWebhookParams, ...) (res *WebhookNewWebhookResponse, err error)
- func (r *WebhookService) ReplaceWebhook(ctx context.Context, appID string, webhookID string, ...) (res *WebhookReplaceWebhookResponse, err error)
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActiveSessionGetActiveSessionResponse ¶
type ActiveSessionGetActiveSessionResponse struct {
Data ActiveSessionGetActiveSessionResponseData `json:"data"`
Success bool `json:"success"`
JSON activeSessionGetActiveSessionResponseJSON `json:"-"`
}
func (*ActiveSessionGetActiveSessionResponse) UnmarshalJSON ¶
func (r *ActiveSessionGetActiveSessionResponse) UnmarshalJSON(data []byte) (err error)
type ActiveSessionGetActiveSessionResponseData ¶
type ActiveSessionGetActiveSessionResponseData struct {
// ID of the session
ID string `json:"id" api:"required"`
// ID of the meeting this session is associated with. In the case of V2 meetings,
// it is always a UUID. In V1 meetings, it is a room name of the form
// `abcdef-ghijkl`
AssociatedID string `json:"associated_id" api:"required"`
// timestamp when session created
CreatedAt string `json:"created_at" api:"required"`
// number of participants currently in the session
LiveParticipants float64 `json:"live_participants" api:"required"`
// number of maximum participants that were in the session
MaxConcurrentParticipants float64 `json:"max_concurrent_participants" api:"required"`
// Title of the meeting this session belongs to
MeetingDisplayName string `json:"meeting_display_name" api:"required"`
// number of minutes consumed since the session started
MinutesConsumed float64 `json:"minutes_consumed" api:"required"`
// App id that hosted this session
OrganizationID string `json:"organization_id" api:"required"`
// timestamp when session started
StartedAt string `json:"started_at" api:"required"`
// current status of session
Status ActiveSessionGetActiveSessionResponseDataStatus `json:"status" api:"required"`
// type of session
Type ActiveSessionGetActiveSessionResponseDataType `json:"type" api:"required"`
// timestamp when session was last updated
UpdatedAt string `json:"updated_at" api:"required"`
BreakoutRooms []interface{} `json:"breakout_rooms"`
// timestamp when session ended
EndedAt string `json:"ended_at"`
// Any meta data about session.
Meta interface{} `json:"meta"`
JSON activeSessionGetActiveSessionResponseDataJSON `json:"-"`
}
func (*ActiveSessionGetActiveSessionResponseData) UnmarshalJSON ¶
func (r *ActiveSessionGetActiveSessionResponseData) UnmarshalJSON(data []byte) (err error)
type ActiveSessionGetActiveSessionResponseDataStatus ¶
type ActiveSessionGetActiveSessionResponseDataStatus string
current status of session
const ( ActiveSessionGetActiveSessionResponseDataStatusLive ActiveSessionGetActiveSessionResponseDataStatus = "LIVE" ActiveSessionGetActiveSessionResponseDataStatusEnded ActiveSessionGetActiveSessionResponseDataStatus = "ENDED" )
func (ActiveSessionGetActiveSessionResponseDataStatus) IsKnown ¶
func (r ActiveSessionGetActiveSessionResponseDataStatus) IsKnown() bool
type ActiveSessionGetActiveSessionResponseDataType ¶
type ActiveSessionGetActiveSessionResponseDataType string
type of session
const ( ActiveSessionGetActiveSessionResponseDataTypeMeeting ActiveSessionGetActiveSessionResponseDataType = "meeting" ActiveSessionGetActiveSessionResponseDataTypeLivestream ActiveSessionGetActiveSessionResponseDataType = "livestream" ActiveSessionGetActiveSessionResponseDataTypeParticipant ActiveSessionGetActiveSessionResponseDataType = "participant" )
func (ActiveSessionGetActiveSessionResponseDataType) IsKnown ¶
func (r ActiveSessionGetActiveSessionResponseDataType) IsKnown() bool
type ActiveSessionKickAllParticipantsResponse ¶
type ActiveSessionKickAllParticipantsResponse struct {
Data ActiveSessionKickAllParticipantsResponseData `json:"data"`
Success bool `json:"success"`
JSON activeSessionKickAllParticipantsResponseJSON `json:"-"`
}
func (*ActiveSessionKickAllParticipantsResponse) UnmarshalJSON ¶
func (r *ActiveSessionKickAllParticipantsResponse) UnmarshalJSON(data []byte) (err error)
type ActiveSessionKickAllParticipantsResponseData ¶
type ActiveSessionKickAllParticipantsResponseData struct {
Action string `json:"action"`
KickedParticipantsCount float64 `json:"kicked_participants_count"`
JSON activeSessionKickAllParticipantsResponseDataJSON `json:"-"`
}
func (*ActiveSessionKickAllParticipantsResponseData) UnmarshalJSON ¶
func (r *ActiveSessionKickAllParticipantsResponseData) UnmarshalJSON(data []byte) (err error)
type ActiveSessionKickParticipantsParams ¶
type ActiveSessionKickParticipantsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
CustomParticipantIDs param.Field[[]string] `json:"custom_participant_ids" api:"required"`
ParticipantIDs param.Field[[]string] `json:"participant_ids" api:"required"`
}
func (ActiveSessionKickParticipantsParams) MarshalJSON ¶
func (r ActiveSessionKickParticipantsParams) MarshalJSON() (data []byte, err error)
type ActiveSessionKickParticipantsResponse ¶
type ActiveSessionKickParticipantsResponse struct {
Data ActiveSessionKickParticipantsResponseData `json:"data"`
Success bool `json:"success"`
JSON activeSessionKickParticipantsResponseJSON `json:"-"`
}
func (*ActiveSessionKickParticipantsResponse) UnmarshalJSON ¶
func (r *ActiveSessionKickParticipantsResponse) UnmarshalJSON(data []byte) (err error)
type ActiveSessionKickParticipantsResponseData ¶
type ActiveSessionKickParticipantsResponseData struct {
Action string `json:"action"`
Participants []ActiveSessionKickParticipantsResponseDataParticipant `json:"participants"`
JSON activeSessionKickParticipantsResponseDataJSON `json:"-"`
}
func (*ActiveSessionKickParticipantsResponseData) UnmarshalJSON ¶
func (r *ActiveSessionKickParticipantsResponseData) UnmarshalJSON(data []byte) (err error)
type ActiveSessionKickParticipantsResponseDataParticipant ¶
type ActiveSessionKickParticipantsResponseDataParticipant struct {
// ID of the session participant
ID string `json:"id" api:"required"`
CreatedAt string `json:"created_at" api:"required"`
UpdatedAt string `json:"updated_at" api:"required"`
// Email of the session participant.
Email string `json:"email"`
// Name of the session participant.
Name string `json:"name"`
// A URL pointing to a picture of the participant.
Picture string `json:"picture"`
JSON activeSessionKickParticipantsResponseDataParticipantJSON `json:"-"`
}
func (*ActiveSessionKickParticipantsResponseDataParticipant) UnmarshalJSON ¶
func (r *ActiveSessionKickParticipantsResponseDataParticipant) UnmarshalJSON(data []byte) (err error)
type ActiveSessionNewPollParams ¶
type ActiveSessionNewPollParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Different options for the question
Options param.Field[[]string] `json:"options" api:"required"`
// Question of the poll
Question param.Field[string] `json:"question" api:"required"`
// if voters on a poll are anonymous
Anonymous param.Field[bool] `json:"anonymous"`
// if votes on an option are visible before a person votes
HideVotes param.Field[bool] `json:"hide_votes"`
}
func (ActiveSessionNewPollParams) MarshalJSON ¶
func (r ActiveSessionNewPollParams) MarshalJSON() (data []byte, err error)
type ActiveSessionNewPollResponse ¶
type ActiveSessionNewPollResponse struct {
Data ActiveSessionNewPollResponseData `json:"data"`
Success bool `json:"success"`
JSON activeSessionNewPollResponseJSON `json:"-"`
}
func (*ActiveSessionNewPollResponse) UnmarshalJSON ¶
func (r *ActiveSessionNewPollResponse) UnmarshalJSON(data []byte) (err error)
type ActiveSessionNewPollResponseData ¶
type ActiveSessionNewPollResponseData struct {
Action string `json:"action"`
Poll ActiveSessionNewPollResponseDataPoll `json:"poll"`
JSON activeSessionNewPollResponseDataJSON `json:"-"`
}
func (*ActiveSessionNewPollResponseData) UnmarshalJSON ¶
func (r *ActiveSessionNewPollResponseData) UnmarshalJSON(data []byte) (err error)
type ActiveSessionNewPollResponseDataPoll ¶
type ActiveSessionNewPollResponseDataPoll struct {
// ID of the poll
ID string `json:"id" api:"required"`
// Answer options
Options []ActiveSessionNewPollResponseDataPollOption `json:"options" api:"required"`
// Question asked by the poll
Question string `json:"question" api:"required"`
Anonymous bool `json:"anonymous"`
CreatedBy string `json:"created_by"`
HideVotes bool `json:"hide_votes"`
Voted []string `json:"voted"`
JSON activeSessionNewPollResponseDataPollJSON `json:"-"`
}
func (*ActiveSessionNewPollResponseDataPoll) UnmarshalJSON ¶
func (r *ActiveSessionNewPollResponseDataPoll) UnmarshalJSON(data []byte) (err error)
type ActiveSessionNewPollResponseDataPollOption ¶
type ActiveSessionNewPollResponseDataPollOption struct {
Count float64 `json:"count" api:"required"`
// Text of the answer option
Text string `json:"text" api:"required"`
Votes []ActiveSessionNewPollResponseDataPollOptionsVote `json:"votes" api:"required"`
JSON activeSessionNewPollResponseDataPollOptionJSON `json:"-"`
}
func (*ActiveSessionNewPollResponseDataPollOption) UnmarshalJSON ¶
func (r *ActiveSessionNewPollResponseDataPollOption) UnmarshalJSON(data []byte) (err error)
type ActiveSessionNewPollResponseDataPollOptionsVote ¶
type ActiveSessionNewPollResponseDataPollOptionsVote struct {
ID string `json:"id" api:"required"`
Name string `json:"name" api:"required"`
JSON activeSessionNewPollResponseDataPollOptionsVoteJSON `json:"-"`
}
func (*ActiveSessionNewPollResponseDataPollOptionsVote) UnmarshalJSON ¶
func (r *ActiveSessionNewPollResponseDataPollOptionsVote) UnmarshalJSON(data []byte) (err error)
type ActiveSessionService ¶
type ActiveSessionService struct {
Options []option.RequestOption
}
ActiveSessionService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewActiveSessionService method instead.
func NewActiveSessionService ¶
func NewActiveSessionService(opts ...option.RequestOption) (r *ActiveSessionService)
NewActiveSessionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ActiveSessionService) GetActiveSession ¶
func (r *ActiveSessionService) GetActiveSession(ctx context.Context, appID string, meetingID string, query ActiveSessionGetActiveSessionParams, opts ...option.RequestOption) (res *ActiveSessionGetActiveSessionResponse, err error)
Returns details of an ongoing active session for the given meeting ID.
func (*ActiveSessionService) KickAllParticipants ¶
func (r *ActiveSessionService) KickAllParticipants(ctx context.Context, appID string, meetingID string, body ActiveSessionKickAllParticipantsParams, opts ...option.RequestOption) (res *ActiveSessionKickAllParticipantsResponse, err error)
Kicks all participants from an active session for the given meeting ID.
func (*ActiveSessionService) KickParticipants ¶
func (r *ActiveSessionService) KickParticipants(ctx context.Context, appID string, meetingID string, params ActiveSessionKickParticipantsParams, opts ...option.RequestOption) (res *ActiveSessionKickParticipantsResponse, err error)
Kicks one or more participants from an active session using user ID or custom participant ID.
func (*ActiveSessionService) NewPoll ¶
func (r *ActiveSessionService) NewPoll(ctx context.Context, appID string, meetingID string, params ActiveSessionNewPollParams, opts ...option.RequestOption) (res *ActiveSessionNewPollResponse, err error)
Creates a new poll in an active session for the given meeting ID.
type AnalyticsGetOrgAnalyticsParams ¶
type AnalyticsGetOrgAnalyticsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// end date in YYYY-MM-DD format
EndDate param.Field[string] `query:"end_date"`
// start date in YYYY-MM-DD format
StartDate param.Field[string] `query:"start_date"`
}
func (AnalyticsGetOrgAnalyticsParams) URLQuery ¶
func (r AnalyticsGetOrgAnalyticsParams) URLQuery() (v url.Values)
URLQuery serializes AnalyticsGetOrgAnalyticsParams's query parameters as `url.Values`.
type AnalyticsGetOrgAnalyticsResponse ¶
type AnalyticsGetOrgAnalyticsResponse struct {
Data AnalyticsGetOrgAnalyticsResponseData `json:"data"`
Success bool `json:"success"`
JSON analyticsGetOrgAnalyticsResponseJSON `json:"-"`
}
func (*AnalyticsGetOrgAnalyticsResponse) UnmarshalJSON ¶
func (r *AnalyticsGetOrgAnalyticsResponse) UnmarshalJSON(data []byte) (err error)
type AnalyticsGetOrgAnalyticsResponseData ¶
type AnalyticsGetOrgAnalyticsResponseData struct {
// Recording statistics of an App during the range specified
RecordingStats AnalyticsGetOrgAnalyticsResponseDataRecordingStats `json:"recording_stats"`
// Session statistics of an App during the range specified
SessionStats AnalyticsGetOrgAnalyticsResponseDataSessionStats `json:"session_stats"`
JSON analyticsGetOrgAnalyticsResponseDataJSON `json:"-"`
}
func (*AnalyticsGetOrgAnalyticsResponseData) UnmarshalJSON ¶
func (r *AnalyticsGetOrgAnalyticsResponseData) UnmarshalJSON(data []byte) (err error)
type AnalyticsGetOrgAnalyticsResponseDataRecordingStats ¶
type AnalyticsGetOrgAnalyticsResponseDataRecordingStats struct {
// Day wise recording stats
DayStats []AnalyticsGetOrgAnalyticsResponseDataRecordingStatsDayStat `json:"day_stats"`
// Total number of recordings during the range specified
RecordingCount int64 `json:"recording_count"`
// Total recording minutes during the range specified
RecordingMinutesConsumed float64 `json:"recording_minutes_consumed"`
JSON analyticsGetOrgAnalyticsResponseDataRecordingStatsJSON `json:"-"`
}
Recording statistics of an App during the range specified
func (*AnalyticsGetOrgAnalyticsResponseDataRecordingStats) UnmarshalJSON ¶
func (r *AnalyticsGetOrgAnalyticsResponseDataRecordingStats) UnmarshalJSON(data []byte) (err error)
type AnalyticsGetOrgAnalyticsResponseDataRecordingStatsDayStat ¶
type AnalyticsGetOrgAnalyticsResponseDataRecordingStatsDayStat struct {
Day string `json:"day"`
// Total recording minutes for a specific day
TotalRecordingMinutes int64 `json:"total_recording_minutes"`
// Total number of recordings for a specific day
TotalRecordings int64 `json:"total_recordings"`
JSON analyticsGetOrgAnalyticsResponseDataRecordingStatsDayStatJSON `json:"-"`
}
func (*AnalyticsGetOrgAnalyticsResponseDataRecordingStatsDayStat) UnmarshalJSON ¶
func (r *AnalyticsGetOrgAnalyticsResponseDataRecordingStatsDayStat) UnmarshalJSON(data []byte) (err error)
type AnalyticsGetOrgAnalyticsResponseDataSessionStats ¶
type AnalyticsGetOrgAnalyticsResponseDataSessionStats struct {
// Day wise session stats
DayStats []AnalyticsGetOrgAnalyticsResponseDataSessionStatsDayStat `json:"day_stats"`
// Total number of sessions during the range specified
SessionsCount int64 `json:"sessions_count"`
// Total session minutes during the range specified
SessionsMinutesConsumed float64 `json:"sessions_minutes_consumed"`
JSON analyticsGetOrgAnalyticsResponseDataSessionStatsJSON `json:"-"`
}
Session statistics of an App during the range specified
func (*AnalyticsGetOrgAnalyticsResponseDataSessionStats) UnmarshalJSON ¶
func (r *AnalyticsGetOrgAnalyticsResponseDataSessionStats) UnmarshalJSON(data []byte) (err error)
type AnalyticsGetOrgAnalyticsResponseDataSessionStatsDayStat ¶
type AnalyticsGetOrgAnalyticsResponseDataSessionStatsDayStat struct {
Day string `json:"day"`
// Total session minutes for a specific day
TotalSessionMinutes float64 `json:"total_session_minutes"`
// Total number of sessions for a specific day
TotalSessions int64 `json:"total_sessions"`
JSON analyticsGetOrgAnalyticsResponseDataSessionStatsDayStatJSON `json:"-"`
}
func (*AnalyticsGetOrgAnalyticsResponseDataSessionStatsDayStat) UnmarshalJSON ¶
func (r *AnalyticsGetOrgAnalyticsResponseDataSessionStatsDayStat) UnmarshalJSON(data []byte) (err error)
type AnalyticsService ¶
type AnalyticsService struct {
Options []option.RequestOption
}
AnalyticsService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAnalyticsService method instead.
func NewAnalyticsService ¶
func NewAnalyticsService(opts ...option.RequestOption) (r *AnalyticsService)
NewAnalyticsService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*AnalyticsService) GetOrgAnalytics ¶
func (r *AnalyticsService) GetOrgAnalytics(ctx context.Context, appID string, params AnalyticsGetOrgAnalyticsParams, opts ...option.RequestOption) (res *AnalyticsGetOrgAnalyticsResponse, err error)
Returns day-wise session and recording analytics data of an App for the specified time range start_date to end_date. If start_date and end_date are not provided, the default time range is set from 30 days ago to the current date.
type AppGetParams ¶
type AppGetResponse ¶
type AppGetResponse struct {
Data []AppGetResponseData `json:"data"`
Success bool `json:"success"`
JSON appGetResponseJSON `json:"-"`
}
func (*AppGetResponse) UnmarshalJSON ¶
func (r *AppGetResponse) UnmarshalJSON(data []byte) (err error)
type AppGetResponseData ¶
type AppGetResponseData struct {
ID string `json:"id"`
CreatedAt string `json:"created_at"`
Name string `json:"name"`
JSON appGetResponseDataJSON `json:"-"`
}
func (*AppGetResponseData) UnmarshalJSON ¶
func (r *AppGetResponseData) UnmarshalJSON(data []byte) (err error)
type AppPostParams ¶
type AppPostParams struct {
AccountID param.Field[string] `path:"account_id" api:"required"`
Name param.Field[string] `json:"name" api:"required"`
}
func (AppPostParams) MarshalJSON ¶
func (r AppPostParams) MarshalJSON() (data []byte, err error)
type AppPostResponse ¶
type AppPostResponse struct {
Data AppPostResponseData `json:"data"`
Success bool `json:"success"`
JSON appPostResponseJSON `json:"-"`
}
func (*AppPostResponse) UnmarshalJSON ¶
func (r *AppPostResponse) UnmarshalJSON(data []byte) (err error)
type AppPostResponseData ¶
type AppPostResponseData struct {
App AppPostResponseDataApp `json:"app"`
JSON appPostResponseDataJSON `json:"-"`
}
func (*AppPostResponseData) UnmarshalJSON ¶
func (r *AppPostResponseData) UnmarshalJSON(data []byte) (err error)
type AppPostResponseDataApp ¶
type AppPostResponseDataApp struct {
ID string `json:"id"`
CreatedAt string `json:"created_at"`
Name string `json:"name"`
JSON appPostResponseDataAppJSON `json:"-"`
}
func (*AppPostResponseDataApp) UnmarshalJSON ¶
func (r *AppPostResponseDataApp) UnmarshalJSON(data []byte) (err error)
type AppService ¶
type AppService struct {
Options []option.RequestOption
}
AppService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAppService method instead.
func NewAppService ¶
func NewAppService(opts ...option.RequestOption) (r *AppService)
NewAppService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*AppService) Get ¶
func (r *AppService) Get(ctx context.Context, query AppGetParams, opts ...option.RequestOption) (res *AppGetResponse, err error)
Fetch all apps for your account
func (*AppService) Post ¶
func (r *AppService) Post(ctx context.Context, params AppPostParams, opts ...option.RequestOption) (res *AppPostResponse, err error)
Create new app for your account
type AuditLogAction ¶
type AuditLogAction = shared.AuditLogAction
This is an alias to an internal type.
type AuditLogActor ¶
type AuditLogActor = shared.AuditLogActor
This is an alias to an internal type.
type AuditLogActorType ¶
type AuditLogActorType = shared.AuditLogActorType
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
type AuditLogOwner ¶
type AuditLogOwner = shared.AuditLogOwner
This is an alias to an internal type.
type AuditLogResource ¶
type AuditLogResource = shared.AuditLogResource
This is an alias to an internal type.
type CertificateCA ¶
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶
type CertificateRequestType = shared.CertificateRequestType
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
This is an alias to an internal type.
type CloudflareTunnel ¶
type CloudflareTunnel = shared.CloudflareTunnel
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
This is an alias to an internal type.
type CloudflareTunnelConfigSrc ¶
type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc
Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.
This is an alias to an internal type.
type CloudflareTunnelConnection ¶
type CloudflareTunnelConnection = shared.CloudflareTunnelConnection
This is an alias to an internal type.
type CloudflareTunnelStatus ¶
type CloudflareTunnelStatus = shared.CloudflareTunnelStatus
The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).
This is an alias to an internal type.
type CloudflareTunnelTunType ¶
type CloudflareTunnelTunType = shared.CloudflareTunnelTunType
The type of tunnel.
This is an alias to an internal type.
type ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type LivestreamGetActiveLivestreamsForLivestreamIDResponse ¶
type LivestreamGetActiveLivestreamsForLivestreamIDResponse struct {
Data LivestreamGetActiveLivestreamsForLivestreamIDResponseData `json:"data"`
Success bool `json:"success"`
JSON livestreamGetActiveLivestreamsForLivestreamIDResponseJSON `json:"-"`
}
func (*LivestreamGetActiveLivestreamsForLivestreamIDResponse) UnmarshalJSON ¶
func (r *LivestreamGetActiveLivestreamsForLivestreamIDResponse) UnmarshalJSON(data []byte) (err error)
type LivestreamGetActiveLivestreamsForLivestreamIDResponseData ¶
type LivestreamGetActiveLivestreamsForLivestreamIDResponseData struct {
Livestream LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestream `json:"livestream"`
Session LivestreamGetActiveLivestreamsForLivestreamIDResponseDataSession `json:"session"`
JSON livestreamGetActiveLivestreamsForLivestreamIDResponseDataJSON `json:"-"`
}
func (*LivestreamGetActiveLivestreamsForLivestreamIDResponseData) UnmarshalJSON ¶
func (r *LivestreamGetActiveLivestreamsForLivestreamIDResponseData) UnmarshalJSON(data []byte) (err error)
type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestream ¶
type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestream struct {
ID string `json:"id"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" format:"date-time"`
// Specifies if the livestream was disabled.
Disabled string `json:"disabled"`
// The server URL to which the RTMP encoder sends the video and audio data.
IngestServer string `json:"ingest_server"`
// ID of the meeting.
MeetingID string `json:"meeting_id"`
// Name of the livestream.
Name string `json:"name"`
// The web address that viewers can use to watch the livestream.
PlaybackURL string `json:"playback_url"`
Status LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus `json:"status"`
// Unique key for accessing each livestream.
StreamKey string `json:"stream_key"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" format:"date-time"`
JSON livestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamJSON `json:"-"`
}
func (*LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestream) UnmarshalJSON ¶
func (r *LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestream) UnmarshalJSON(data []byte) (err error)
type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus ¶
type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus string
const ( LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatusLive LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus = "LIVE" LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatusIdle LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus = "IDLE" LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatusErrored LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus = "ERRORED" LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatusInvoked LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus = "INVOKED" )
func (LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus) IsKnown ¶
func (r LivestreamGetActiveLivestreamsForLivestreamIDResponseDataLivestreamStatus) IsKnown() bool
type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataSession ¶
type LivestreamGetActiveLivestreamsForLivestreamIDResponseDataSession struct {
ID string `json:"id"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" format:"date-time"`
ErrMessage string `json:"err_message"`
// The time duration for which the input was given or the meeting was streamed.
IngestSeconds string `json:"ingest_seconds"`
// Timestamp the object was invoked. The time is returned in ISO format.
InvokedTime time.Time `json:"invoked_time" format:"date-time"`
LivestreamID string `json:"livestream_id"`
// Timestamp the object was started. The time is returned in ISO format.
StartedTime time.Time `json:"started_time" format:"date-time"`
// Timestamp the object was stopped. The time is returned in ISO format.
StoppedTime time.Time `json:"stopped_time" format:"date-time"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" format:"date-time"`
// The total view time for which the viewers watched the stream.
ViewerSeconds string `json:"viewer_seconds"`
JSON livestreamGetActiveLivestreamsForLivestreamIDResponseDataSessionJSON `json:"-"`
}
func (*LivestreamGetActiveLivestreamsForLivestreamIDResponseDataSession) UnmarshalJSON ¶
func (r *LivestreamGetActiveLivestreamsForLivestreamIDResponseDataSession) UnmarshalJSON(data []byte) (err error)
type LivestreamGetAllLivestreamsParams ¶
type LivestreamGetAllLivestreamsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Specify the end time range in ISO format to access the live stream.
EndTime param.Field[time.Time] `query:"end_time" format:"date-time"`
// Exclude the RealtimeKit meetings that are livestreamed.
ExcludeMeetings param.Field[bool] `query:"exclude_meetings"`
// The page number from which you want your page search results to be displayed.
PageNo param.Field[int64] `query:"page_no"`
// Number of results per page.
PerPage param.Field[int64] `query:"per_page"`
// Specifies the sorting order for the results.
SortOrder param.Field[LivestreamGetAllLivestreamsParamsSortOrder] `query:"sort_order"`
// Specify the start time range in ISO format to access the live stream.
StartTime param.Field[time.Time] `query:"start_time" format:"date-time"`
// Specifies the status of the operation.
Status param.Field[LivestreamGetAllLivestreamsParamsStatus] `query:"status"`
}
func (LivestreamGetAllLivestreamsParams) URLQuery ¶
func (r LivestreamGetAllLivestreamsParams) URLQuery() (v url.Values)
URLQuery serializes LivestreamGetAllLivestreamsParams's query parameters as `url.Values`.
type LivestreamGetAllLivestreamsParamsSortOrder ¶
type LivestreamGetAllLivestreamsParamsSortOrder string
Specifies the sorting order for the results.
const ( LivestreamGetAllLivestreamsParamsSortOrderAsc LivestreamGetAllLivestreamsParamsSortOrder = "ASC" LivestreamGetAllLivestreamsParamsSortOrderDsc LivestreamGetAllLivestreamsParamsSortOrder = "DSC" )
func (LivestreamGetAllLivestreamsParamsSortOrder) IsKnown ¶
func (r LivestreamGetAllLivestreamsParamsSortOrder) IsKnown() bool
type LivestreamGetAllLivestreamsParamsStatus ¶
type LivestreamGetAllLivestreamsParamsStatus string
Specifies the status of the operation.
const ( LivestreamGetAllLivestreamsParamsStatusLive LivestreamGetAllLivestreamsParamsStatus = "LIVE" LivestreamGetAllLivestreamsParamsStatusIdle LivestreamGetAllLivestreamsParamsStatus = "IDLE" LivestreamGetAllLivestreamsParamsStatusErrored LivestreamGetAllLivestreamsParamsStatus = "ERRORED" LivestreamGetAllLivestreamsParamsStatusInvoked LivestreamGetAllLivestreamsParamsStatus = "INVOKED" )
func (LivestreamGetAllLivestreamsParamsStatus) IsKnown ¶
func (r LivestreamGetAllLivestreamsParamsStatus) IsKnown() bool
type LivestreamGetAllLivestreamsResponse ¶
type LivestreamGetAllLivestreamsResponse struct {
Data LivestreamGetAllLivestreamsResponseData `json:"data"`
Success bool `json:"success"`
JSON livestreamGetAllLivestreamsResponseJSON `json:"-"`
}
func (*LivestreamGetAllLivestreamsResponse) UnmarshalJSON ¶
func (r *LivestreamGetAllLivestreamsResponse) UnmarshalJSON(data []byte) (err error)
type LivestreamGetAllLivestreamsResponseData ¶
type LivestreamGetAllLivestreamsResponseData struct {
// The ID of the livestream.
ID string `json:"id" format:"uuid"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" format:"date-time"`
// Specifies if the livestream was disabled.
Disabled string `json:"disabled"`
// The server URL to which the RTMP encoder sends the video and audio data.
IngestServer string `json:"ingest_server"`
// ID of the meeting.
MeetingID string `json:"meeting_id"`
// Name of the livestream.
Name string `json:"name"`
Paging LivestreamGetAllLivestreamsResponseDataPaging `json:"paging"`
// The web address that viewers can use to watch the livestream.
PlaybackURL string `json:"playback_url"`
Status LivestreamGetAllLivestreamsResponseDataStatus `json:"status"`
// Unique key for accessing each livestream.
StreamKey string `json:"stream_key"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" format:"date-time"`
JSON livestreamGetAllLivestreamsResponseDataJSON `json:"-"`
}
func (*LivestreamGetAllLivestreamsResponseData) UnmarshalJSON ¶
func (r *LivestreamGetAllLivestreamsResponseData) UnmarshalJSON(data []byte) (err error)
type LivestreamGetAllLivestreamsResponseDataPaging ¶
type LivestreamGetAllLivestreamsResponseDataPaging struct {
EndOffset int64 `json:"end_offset"`
StartOffset int64 `json:"start_offset"`
TotalCount int64 `json:"total_count"`
JSON livestreamGetAllLivestreamsResponseDataPagingJSON `json:"-"`
}
func (*LivestreamGetAllLivestreamsResponseDataPaging) UnmarshalJSON ¶
func (r *LivestreamGetAllLivestreamsResponseDataPaging) UnmarshalJSON(data []byte) (err error)
type LivestreamGetAllLivestreamsResponseDataStatus ¶
type LivestreamGetAllLivestreamsResponseDataStatus string
const ( LivestreamGetAllLivestreamsResponseDataStatusLive LivestreamGetAllLivestreamsResponseDataStatus = "LIVE" LivestreamGetAllLivestreamsResponseDataStatusIdle LivestreamGetAllLivestreamsResponseDataStatus = "IDLE" LivestreamGetAllLivestreamsResponseDataStatusErrored LivestreamGetAllLivestreamsResponseDataStatus = "ERRORED" LivestreamGetAllLivestreamsResponseDataStatusInvoked LivestreamGetAllLivestreamsResponseDataStatus = "INVOKED" )
func (LivestreamGetAllLivestreamsResponseDataStatus) IsKnown ¶
func (r LivestreamGetAllLivestreamsResponseDataStatus) IsKnown() bool
type LivestreamGetLivestreamAnalyticsCompleteParams ¶
type LivestreamGetLivestreamAnalyticsCompleteParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Specify the end time range in ISO format to access the livestream analytics.
EndTime param.Field[time.Time] `query:"end_time" format:"date-time"`
// Specify the start time range in ISO format to access the livestream analytics.
StartTime param.Field[time.Time] `query:"start_time" format:"date-time"`
}
func (LivestreamGetLivestreamAnalyticsCompleteParams) URLQuery ¶
func (r LivestreamGetLivestreamAnalyticsCompleteParams) URLQuery() (v url.Values)
URLQuery serializes LivestreamGetLivestreamAnalyticsCompleteParams's query parameters as `url.Values`.
type LivestreamGetLivestreamAnalyticsCompleteResponse ¶
type LivestreamGetLivestreamAnalyticsCompleteResponse struct {
Data LivestreamGetLivestreamAnalyticsCompleteResponseData `json:"data"`
Success bool `json:"success"`
JSON livestreamGetLivestreamAnalyticsCompleteResponseJSON `json:"-"`
}
func (*LivestreamGetLivestreamAnalyticsCompleteResponse) UnmarshalJSON ¶
func (r *LivestreamGetLivestreamAnalyticsCompleteResponse) UnmarshalJSON(data []byte) (err error)
type LivestreamGetLivestreamAnalyticsCompleteResponseData ¶
type LivestreamGetLivestreamAnalyticsCompleteResponseData struct {
// Count of total livestreams.
Count int64 `json:"count"`
// Total time duration for which the input was given or the meeting was streamed.
TotalIngestSeconds int64 `json:"total_ingest_seconds"`
// Total view time for which the viewers watched the stream.
TotalViewerSeconds int64 `json:"total_viewer_seconds"`
JSON livestreamGetLivestreamAnalyticsCompleteResponseDataJSON `json:"-"`
}
func (*LivestreamGetLivestreamAnalyticsCompleteResponseData) UnmarshalJSON ¶
func (r *LivestreamGetLivestreamAnalyticsCompleteResponseData) UnmarshalJSON(data []byte) (err error)
type LivestreamGetLivestreamSessionDetailsForSessionIDResponse ¶
type LivestreamGetLivestreamSessionDetailsForSessionIDResponse struct {
Data LivestreamGetLivestreamSessionDetailsForSessionIDResponseData `json:"data"`
Success bool `json:"success"`
JSON livestreamGetLivestreamSessionDetailsForSessionIDResponseJSON `json:"-"`
}
func (*LivestreamGetLivestreamSessionDetailsForSessionIDResponse) UnmarshalJSON ¶
func (r *LivestreamGetLivestreamSessionDetailsForSessionIDResponse) UnmarshalJSON(data []byte) (err error)
type LivestreamGetLivestreamSessionDetailsForSessionIDResponseData ¶
type LivestreamGetLivestreamSessionDetailsForSessionIDResponseData struct {
// The livestream ID.
ID string `json:"id"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" format:"date-time"`
// The server URL to which the RTMP encoder sends the video and audio data.
ErrMessage string `json:"err_message"`
// Name of the livestream.
IngestSeconds int64 `json:"ingest_seconds"`
LivestreamID string `json:"livestream_id"`
// Unique key for accessing each livestream.
StartedTime string `json:"started_time"`
// The web address that viewers can use to watch the livestream.
StoppedTime string `json:"stopped_time"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt string `json:"updated_at"`
// Specifies if the livestream was disabled.
ViewerSeconds int64 `json:"viewer_seconds"`
JSON livestreamGetLivestreamSessionDetailsForSessionIDResponseDataJSON `json:"-"`
}
func (*LivestreamGetLivestreamSessionDetailsForSessionIDResponseData) UnmarshalJSON ¶
func (r *LivestreamGetLivestreamSessionDetailsForSessionIDResponseData) UnmarshalJSON(data []byte) (err error)
type LivestreamGetLivestreamSessionForLivestreamIDParams ¶
type LivestreamGetLivestreamSessionForLivestreamIDParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// The page number from which you want your page search results to be displayed.
PageNo param.Field[int64] `query:"page_no"`
// Number of results per page.
PerPage param.Field[int64] `query:"per_page"`
}
func (LivestreamGetLivestreamSessionForLivestreamIDParams) URLQuery ¶
func (r LivestreamGetLivestreamSessionForLivestreamIDParams) URLQuery() (v url.Values)
URLQuery serializes LivestreamGetLivestreamSessionForLivestreamIDParams's query parameters as `url.Values`.
type LivestreamGetLivestreamSessionForLivestreamIDResponse ¶
type LivestreamGetLivestreamSessionForLivestreamIDResponse struct {
Data LivestreamGetLivestreamSessionForLivestreamIDResponseData `json:"data"`
Success bool `json:"success"`
JSON livestreamGetLivestreamSessionForLivestreamIDResponseJSON `json:"-"`
}
func (*LivestreamGetLivestreamSessionForLivestreamIDResponse) UnmarshalJSON ¶
func (r *LivestreamGetLivestreamSessionForLivestreamIDResponse) UnmarshalJSON(data []byte) (err error)
type LivestreamGetLivestreamSessionForLivestreamIDResponseData ¶
type LivestreamGetLivestreamSessionForLivestreamIDResponseData struct {
Livestream LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestream `json:"livestream"`
Paging LivestreamGetLivestreamSessionForLivestreamIDResponseDataPaging `json:"paging"`
Session LivestreamGetLivestreamSessionForLivestreamIDResponseDataSession `json:"session"`
JSON livestreamGetLivestreamSessionForLivestreamIDResponseDataJSON `json:"-"`
}
func (*LivestreamGetLivestreamSessionForLivestreamIDResponseData) UnmarshalJSON ¶
func (r *LivestreamGetLivestreamSessionForLivestreamIDResponseData) UnmarshalJSON(data []byte) (err error)
type LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestream ¶
type LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestream struct {
// ID of the livestream.
ID string `json:"id"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt string `json:"created_at"`
// Specifies if the livestream was disabled.
Disabled string `json:"disabled"`
// The server URL to which the RTMP encoder sends the video and audio data.
IngestServer string `json:"ingest_server"`
// The ID of the meeting.
MeetingID string `json:"meeting_id"`
// Name of the livestream.
Name string `json:"name"`
// The web address that viewers can use to watch the livestream.
PlaybackURL string `json:"playback_url"`
Status LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus `json:"status"`
// Unique key for accessing each livestream.
StreamKey string `json:"stream_key"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt string `json:"updated_at"`
JSON livestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamJSON `json:"-"`
}
func (*LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestream) UnmarshalJSON ¶
func (r *LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestream) UnmarshalJSON(data []byte) (err error)
type LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus ¶
type LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus string
const ( LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusLive LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "LIVE" LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusIdle LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "IDLE" LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusErrored LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "ERRORED" LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatusInvoked LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus = "INVOKED" )
func (LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus) IsKnown ¶
func (r LivestreamGetLivestreamSessionForLivestreamIDResponseDataLivestreamStatus) IsKnown() bool
type LivestreamGetLivestreamSessionForLivestreamIDResponseDataPaging ¶
type LivestreamGetLivestreamSessionForLivestreamIDResponseDataPaging struct {
EndOffset int64 `json:"end_offset"`
StartOffset int64 `json:"start_offset"`
TotalCount int64 `json:"total_count"`
JSON livestreamGetLivestreamSessionForLivestreamIDResponseDataPagingJSON `json:"-"`
}
func (*LivestreamGetLivestreamSessionForLivestreamIDResponseDataPaging) UnmarshalJSON ¶
func (r *LivestreamGetLivestreamSessionForLivestreamIDResponseDataPaging) UnmarshalJSON(data []byte) (err error)
type LivestreamGetLivestreamSessionForLivestreamIDResponseDataSession ¶
type LivestreamGetLivestreamSessionForLivestreamIDResponseDataSession struct {
// ID of the session.
ID string `json:"id"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" format:"date-time"`
ErrMessage string `json:"err_message"`
// The time duration for which the input was given or the meeting was streamed.
IngestSeconds float64 `json:"ingest_seconds"`
// Timestamp the object was invoked. The time is returned in ISO format.
InvokedTime time.Time `json:"invoked_time" format:"date-time"`
LivestreamID string `json:"livestream_id"`
// Timestamp the object was started. The time is returned in ISO format.
StartedTime time.Time `json:"started_time" format:"date-time"`
// Timestamp the object was stopped. The time is returned in ISO format.
StoppedTime time.Time `json:"stopped_time" format:"date-time"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" format:"date-time"`
// The total view time for which the viewers watched the stream.
ViewerSeconds float64 `json:"viewer_seconds"`
JSON livestreamGetLivestreamSessionForLivestreamIDResponseDataSessionJSON `json:"-"`
}
func (*LivestreamGetLivestreamSessionForLivestreamIDResponseDataSession) UnmarshalJSON ¶
func (r *LivestreamGetLivestreamSessionForLivestreamIDResponseDataSession) UnmarshalJSON(data []byte) (err error)
type LivestreamGetMeetingActiveLivestreamsResponse ¶
type LivestreamGetMeetingActiveLivestreamsResponse struct {
Data LivestreamGetMeetingActiveLivestreamsResponseData `json:"data"`
Success bool `json:"success"`
JSON livestreamGetMeetingActiveLivestreamsResponseJSON `json:"-"`
}
func (*LivestreamGetMeetingActiveLivestreamsResponse) UnmarshalJSON ¶
func (r *LivestreamGetMeetingActiveLivestreamsResponse) UnmarshalJSON(data []byte) (err error)
type LivestreamGetMeetingActiveLivestreamsResponseData ¶
type LivestreamGetMeetingActiveLivestreamsResponseData struct {
// The livestream ID.
ID string `json:"id"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" format:"date-time"`
// Specifies if the livestream was disabled.
Disabled string `json:"disabled"`
// The server URL to which the RTMP encoder sends the video and audio data.
IngestServer string `json:"ingest_server"`
MeetingID string `json:"meeting_id"`
// Name of the livestream.
Name string `json:"name" api:"nullable"`
// The web address that viewers can use to watch the livestream.
PlaybackURL string `json:"playback_url"`
Status LivestreamGetMeetingActiveLivestreamsResponseDataStatus `json:"status"`
// Unique key for accessing each livestream.
StreamKey string `json:"stream_key"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" format:"date-time"`
JSON livestreamGetMeetingActiveLivestreamsResponseDataJSON `json:"-"`
}
func (*LivestreamGetMeetingActiveLivestreamsResponseData) UnmarshalJSON ¶
func (r *LivestreamGetMeetingActiveLivestreamsResponseData) UnmarshalJSON(data []byte) (err error)
type LivestreamGetMeetingActiveLivestreamsResponseDataStatus ¶
type LivestreamGetMeetingActiveLivestreamsResponseDataStatus string
const ( LivestreamGetMeetingActiveLivestreamsResponseDataStatusLive LivestreamGetMeetingActiveLivestreamsResponseDataStatus = "LIVE" LivestreamGetMeetingActiveLivestreamsResponseDataStatusIdle LivestreamGetMeetingActiveLivestreamsResponseDataStatus = "IDLE" LivestreamGetMeetingActiveLivestreamsResponseDataStatusErrored LivestreamGetMeetingActiveLivestreamsResponseDataStatus = "ERRORED" LivestreamGetMeetingActiveLivestreamsResponseDataStatusInvoked LivestreamGetMeetingActiveLivestreamsResponseDataStatus = "INVOKED" )
func (LivestreamGetMeetingActiveLivestreamsResponseDataStatus) IsKnown ¶
func (r LivestreamGetMeetingActiveLivestreamsResponseDataStatus) IsKnown() bool
type LivestreamGetOrgAnalyticsParams ¶
type LivestreamGetOrgAnalyticsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// end date in YYYY-MM-DD format
EndDate param.Field[string] `query:"end_date"`
// start date in YYYY-MM-DD format
StartDate param.Field[string] `query:"start_date"`
}
func (LivestreamGetOrgAnalyticsParams) URLQuery ¶
func (r LivestreamGetOrgAnalyticsParams) URLQuery() (v url.Values)
URLQuery serializes LivestreamGetOrgAnalyticsParams's query parameters as `url.Values`.
type LivestreamGetOrgAnalyticsResponse ¶
type LivestreamGetOrgAnalyticsResponse struct {
Data LivestreamGetOrgAnalyticsResponseData `json:"data"`
Success bool `json:"success"`
JSON livestreamGetOrgAnalyticsResponseJSON `json:"-"`
}
func (*LivestreamGetOrgAnalyticsResponse) UnmarshalJSON ¶
func (r *LivestreamGetOrgAnalyticsResponse) UnmarshalJSON(data []byte) (err error)
type LivestreamGetOrgAnalyticsResponseData ¶
type LivestreamGetOrgAnalyticsResponseData struct {
// Recording statistics of an App during the range specified
RecordingStats LivestreamGetOrgAnalyticsResponseDataRecordingStats `json:"recording_stats"`
// Session statistics of an App during the range specified
SessionStats LivestreamGetOrgAnalyticsResponseDataSessionStats `json:"session_stats"`
JSON livestreamGetOrgAnalyticsResponseDataJSON `json:"-"`
}
func (*LivestreamGetOrgAnalyticsResponseData) UnmarshalJSON ¶
func (r *LivestreamGetOrgAnalyticsResponseData) UnmarshalJSON(data []byte) (err error)
type LivestreamGetOrgAnalyticsResponseDataRecordingStats ¶
type LivestreamGetOrgAnalyticsResponseDataRecordingStats struct {
// Day wise recording stats
DayStats []LivestreamGetOrgAnalyticsResponseDataRecordingStatsDayStat `json:"day_stats"`
// Total number of recordings during the range specified
RecordingCount int64 `json:"recording_count"`
// Total recording minutes during the range specified
RecordingMinutesConsumed float64 `json:"recording_minutes_consumed"`
JSON livestreamGetOrgAnalyticsResponseDataRecordingStatsJSON `json:"-"`
}
Recording statistics of an App during the range specified
func (*LivestreamGetOrgAnalyticsResponseDataRecordingStats) UnmarshalJSON ¶
func (r *LivestreamGetOrgAnalyticsResponseDataRecordingStats) UnmarshalJSON(data []byte) (err error)
type LivestreamGetOrgAnalyticsResponseDataRecordingStatsDayStat ¶
type LivestreamGetOrgAnalyticsResponseDataRecordingStatsDayStat struct {
Day string `json:"day"`
// Total recording minutes for a specific day
TotalRecordingMinutes int64 `json:"total_recording_minutes"`
// Total number of recordings for a specific day
TotalRecordings int64 `json:"total_recordings"`
JSON livestreamGetOrgAnalyticsResponseDataRecordingStatsDayStatJSON `json:"-"`
}
func (*LivestreamGetOrgAnalyticsResponseDataRecordingStatsDayStat) UnmarshalJSON ¶
func (r *LivestreamGetOrgAnalyticsResponseDataRecordingStatsDayStat) UnmarshalJSON(data []byte) (err error)
type LivestreamGetOrgAnalyticsResponseDataSessionStats ¶
type LivestreamGetOrgAnalyticsResponseDataSessionStats struct {
// Day wise session stats
DayStats []LivestreamGetOrgAnalyticsResponseDataSessionStatsDayStat `json:"day_stats"`
// Total number of sessions during the range specified
SessionsCount int64 `json:"sessions_count"`
// Total session minutes during the range specified
SessionsMinutesConsumed float64 `json:"sessions_minutes_consumed"`
JSON livestreamGetOrgAnalyticsResponseDataSessionStatsJSON `json:"-"`
}
Session statistics of an App during the range specified
func (*LivestreamGetOrgAnalyticsResponseDataSessionStats) UnmarshalJSON ¶
func (r *LivestreamGetOrgAnalyticsResponseDataSessionStats) UnmarshalJSON(data []byte) (err error)
type LivestreamGetOrgAnalyticsResponseDataSessionStatsDayStat ¶
type LivestreamGetOrgAnalyticsResponseDataSessionStatsDayStat struct {
Day string `json:"day"`
// Total session minutes for a specific day
TotalSessionMinutes float64 `json:"total_session_minutes"`
// Total number of sessions for a specific day
TotalSessions int64 `json:"total_sessions"`
JSON livestreamGetOrgAnalyticsResponseDataSessionStatsDayStatJSON `json:"-"`
}
func (*LivestreamGetOrgAnalyticsResponseDataSessionStatsDayStat) UnmarshalJSON ¶
func (r *LivestreamGetOrgAnalyticsResponseDataSessionStatsDayStat) UnmarshalJSON(data []byte) (err error)
type LivestreamNewIndependentLivestreamParams ¶
type LivestreamNewIndependentLivestreamParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Name of the livestream
Name param.Field[string] `json:"name"`
}
func (LivestreamNewIndependentLivestreamParams) MarshalJSON ¶
func (r LivestreamNewIndependentLivestreamParams) MarshalJSON() (data []byte, err error)
type LivestreamNewIndependentLivestreamResponse ¶
type LivestreamNewIndependentLivestreamResponse struct {
Data LivestreamNewIndependentLivestreamResponseData `json:"data"`
Success bool `json:"success"`
JSON livestreamNewIndependentLivestreamResponseJSON `json:"-"`
}
func (*LivestreamNewIndependentLivestreamResponse) UnmarshalJSON ¶
func (r *LivestreamNewIndependentLivestreamResponse) UnmarshalJSON(data []byte) (err error)
type LivestreamNewIndependentLivestreamResponseData ¶
type LivestreamNewIndependentLivestreamResponseData struct {
// The livestream ID.
ID string `json:"id"`
// Specifies if the livestream was disabled.
Disabled bool `json:"disabled"`
// The server URL to which the RTMP encoder should send the video and audio data.
IngestServer string `json:"ingest_server"`
MeetingID string `json:"meeting_id" api:"nullable"`
Name string `json:"name"`
// The web address that viewers can use to watch the livestream.
PlaybackURL string `json:"playback_url"`
Status LivestreamNewIndependentLivestreamResponseDataStatus `json:"status"`
// Unique key for accessing each livestream.
StreamKey string `json:"stream_key"`
JSON livestreamNewIndependentLivestreamResponseDataJSON `json:"-"`
}
func (*LivestreamNewIndependentLivestreamResponseData) UnmarshalJSON ¶
func (r *LivestreamNewIndependentLivestreamResponseData) UnmarshalJSON(data []byte) (err error)
type LivestreamNewIndependentLivestreamResponseDataStatus ¶
type LivestreamNewIndependentLivestreamResponseDataStatus string
const ( LivestreamNewIndependentLivestreamResponseDataStatusLive LivestreamNewIndependentLivestreamResponseDataStatus = "LIVE" LivestreamNewIndependentLivestreamResponseDataStatusIdle LivestreamNewIndependentLivestreamResponseDataStatus = "IDLE" LivestreamNewIndependentLivestreamResponseDataStatusErrored LivestreamNewIndependentLivestreamResponseDataStatus = "ERRORED" LivestreamNewIndependentLivestreamResponseDataStatusInvoked LivestreamNewIndependentLivestreamResponseDataStatus = "INVOKED" )
func (LivestreamNewIndependentLivestreamResponseDataStatus) IsKnown ¶
func (r LivestreamNewIndependentLivestreamResponseDataStatus) IsKnown() bool
type LivestreamService ¶
type LivestreamService struct {
Options []option.RequestOption
}
LivestreamService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewLivestreamService method instead.
func NewLivestreamService ¶
func NewLivestreamService(opts ...option.RequestOption) (r *LivestreamService)
NewLivestreamService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*LivestreamService) GetActiveLivestreamsForLivestreamID ¶
func (r *LivestreamService) GetActiveLivestreamsForLivestreamID(ctx context.Context, appID string, livestreamID string, query LivestreamGetActiveLivestreamsForLivestreamIDParams, opts ...option.RequestOption) (res *LivestreamGetActiveLivestreamsForLivestreamIDResponse, err error)
Returns details of all active livestreams for the given livestream ID. Retreive the livestream ID using the `Start livestreaming a meeting` API.
func (*LivestreamService) GetAllLivestreams ¶
func (r *LivestreamService) GetAllLivestreams(ctx context.Context, appID string, params LivestreamGetAllLivestreamsParams, opts ...option.RequestOption) (res *LivestreamGetAllLivestreamsResponse, err error)
Returns details of livestreams associated with the given App ID. It includes livestreams created by your App and RealtimeKit meetings that are livestreamed by your App. If you only want details of livestreams created by your App and not RealtimeKit meetings, you can use the `exclude_meetings` query parameter.
func (*LivestreamService) GetLivestreamAnalyticsComplete ¶
func (r *LivestreamService) GetLivestreamAnalyticsComplete(ctx context.Context, appID string, params LivestreamGetLivestreamAnalyticsCompleteParams, opts ...option.RequestOption) (res *LivestreamGetLivestreamAnalyticsCompleteResponse, err error)
Returns livestream analytics for the specified time range.
func (*LivestreamService) GetLivestreamSessionDetailsForSessionID ¶
func (r *LivestreamService) GetLivestreamSessionDetailsForSessionID(ctx context.Context, appID string, livestreamSessionID string, query LivestreamGetLivestreamSessionDetailsForSessionIDParams, opts ...option.RequestOption) (res *LivestreamGetLivestreamSessionDetailsForSessionIDResponse, err error)
Returns livestream session details for the given livestream session ID. Retrieve the `livestream_session_id`using the `Fetch livestream session details using a session ID` API.
func (*LivestreamService) GetLivestreamSessionForLivestreamID ¶
func (r *LivestreamService) GetLivestreamSessionForLivestreamID(ctx context.Context, appID string, livestreamID string, params LivestreamGetLivestreamSessionForLivestreamIDParams, opts ...option.RequestOption) (res *LivestreamGetLivestreamSessionForLivestreamIDResponse, err error)
Returns details of a livestream with sessions for the given livestream ID. Retreive the livestream ID using the `Start livestreaming a meeting` API.
func (*LivestreamService) GetMeetingActiveLivestreams ¶
func (r *LivestreamService) GetMeetingActiveLivestreams(ctx context.Context, appID string, meetingID string, query LivestreamGetMeetingActiveLivestreamsParams, opts ...option.RequestOption) (res *LivestreamGetMeetingActiveLivestreamsResponse, err error)
Returns details of all active livestreams for the given meeting ID.
func (*LivestreamService) GetOrgAnalytics ¶
func (r *LivestreamService) GetOrgAnalytics(ctx context.Context, appID string, params LivestreamGetOrgAnalyticsParams, opts ...option.RequestOption) (res *LivestreamGetOrgAnalyticsResponse, err error)
Returns day-wise session and recording analytics data of an App for the specified time range start_date to end_date. If start_date and end_date are not provided, the default time range is set from 30 days ago to the current date.
func (*LivestreamService) NewIndependentLivestream ¶
func (r *LivestreamService) NewIndependentLivestream(ctx context.Context, appID string, params LivestreamNewIndependentLivestreamParams, opts ...option.RequestOption) (res *LivestreamNewIndependentLivestreamResponse, err error)
Creates a livestream for the given App ID and returns ingest server, stream key, and playback URL. You can pass custom input to the ingest server and stream key, and freely distribute the content using the playback URL on any player that supports HLS/LHLS.
func (*LivestreamService) StartLivestreamingAMeeting ¶
func (r *LivestreamService) StartLivestreamingAMeeting(ctx context.Context, appID string, meetingID string, params LivestreamStartLivestreamingAMeetingParams, opts ...option.RequestOption) (res *LivestreamStartLivestreamingAMeetingResponse, err error)
Starts livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the `Create a meeting` API.
func (*LivestreamService) StopLivestreamingAMeeting ¶
func (r *LivestreamService) StopLivestreamingAMeeting(ctx context.Context, appID string, meetingID string, body LivestreamStopLivestreamingAMeetingParams, opts ...option.RequestOption) (res *LivestreamStopLivestreamingAMeetingResponse, err error)
Stops the active livestream of a meeting associated with the given meeting ID. Retreive the meeting ID using the `Create a meeting` API.
type LivestreamStartLivestreamingAMeetingParams ¶
type LivestreamStartLivestreamingAMeetingParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
Name param.Field[string] `json:"name"`
VideoConfig param.Field[LivestreamStartLivestreamingAMeetingParamsVideoConfig] `json:"video_config"`
}
func (LivestreamStartLivestreamingAMeetingParams) MarshalJSON ¶
func (r LivestreamStartLivestreamingAMeetingParams) MarshalJSON() (data []byte, err error)
type LivestreamStartLivestreamingAMeetingParamsVideoConfig ¶
type LivestreamStartLivestreamingAMeetingParamsVideoConfig struct {
// Height of the livestreaming video in pixels
Height param.Field[int64] `json:"height"`
// Width of the livestreaming video in pixels
Width param.Field[int64] `json:"width"`
}
func (LivestreamStartLivestreamingAMeetingParamsVideoConfig) MarshalJSON ¶
func (r LivestreamStartLivestreamingAMeetingParamsVideoConfig) MarshalJSON() (data []byte, err error)
type LivestreamStartLivestreamingAMeetingResponse ¶
type LivestreamStartLivestreamingAMeetingResponse struct {
Data LivestreamStartLivestreamingAMeetingResponseData `json:"data"`
Success bool `json:"success"`
JSON livestreamStartLivestreamingAMeetingResponseJSON `json:"-"`
}
func (*LivestreamStartLivestreamingAMeetingResponse) UnmarshalJSON ¶
func (r *LivestreamStartLivestreamingAMeetingResponse) UnmarshalJSON(data []byte) (err error)
type LivestreamStartLivestreamingAMeetingResponseData ¶
type LivestreamStartLivestreamingAMeetingResponseData struct {
// The livestream ID.
ID string `json:"id"`
// The server URL to which the RTMP encoder sends the video and audio data.
IngestServer string `json:"ingest_server"`
// The web address that viewers can use to watch the livestream.
PlaybackURL string `json:"playback_url"`
Status LivestreamStartLivestreamingAMeetingResponseDataStatus `json:"status"`
// Unique key for accessing each livestream.
StreamKey string `json:"stream_key"`
JSON livestreamStartLivestreamingAMeetingResponseDataJSON `json:"-"`
}
func (*LivestreamStartLivestreamingAMeetingResponseData) UnmarshalJSON ¶
func (r *LivestreamStartLivestreamingAMeetingResponseData) UnmarshalJSON(data []byte) (err error)
type LivestreamStartLivestreamingAMeetingResponseDataStatus ¶
type LivestreamStartLivestreamingAMeetingResponseDataStatus string
const ( LivestreamStartLivestreamingAMeetingResponseDataStatusLive LivestreamStartLivestreamingAMeetingResponseDataStatus = "LIVE" LivestreamStartLivestreamingAMeetingResponseDataStatusIdle LivestreamStartLivestreamingAMeetingResponseDataStatus = "IDLE" LivestreamStartLivestreamingAMeetingResponseDataStatusErrored LivestreamStartLivestreamingAMeetingResponseDataStatus = "ERRORED" LivestreamStartLivestreamingAMeetingResponseDataStatusInvoked LivestreamStartLivestreamingAMeetingResponseDataStatus = "INVOKED" )
func (LivestreamStartLivestreamingAMeetingResponseDataStatus) IsKnown ¶
func (r LivestreamStartLivestreamingAMeetingResponseDataStatus) IsKnown() bool
type LivestreamStopLivestreamingAMeetingResponse ¶
type LivestreamStopLivestreamingAMeetingResponse struct {
Data LivestreamStopLivestreamingAMeetingResponseData `json:"data"`
Success bool `json:"success"`
JSON livestreamStopLivestreamingAMeetingResponseJSON `json:"-"`
}
func (*LivestreamStopLivestreamingAMeetingResponse) UnmarshalJSON ¶
func (r *LivestreamStopLivestreamingAMeetingResponse) UnmarshalJSON(data []byte) (err error)
type LivestreamStopLivestreamingAMeetingResponseData ¶
type LivestreamStopLivestreamingAMeetingResponseData struct {
Message string `json:"message"`
JSON livestreamStopLivestreamingAMeetingResponseDataJSON `json:"-"`
}
func (*LivestreamStopLivestreamingAMeetingResponseData) UnmarshalJSON ¶
func (r *LivestreamStopLivestreamingAMeetingResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingAddParticipantParams ¶
type MeetingAddParticipantParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// A unique participant ID. You must specify a unique ID for the participant, for
// example, UUID, email address, and so on.
CustomParticipantID param.Field[string] `json:"custom_participant_id" api:"required"`
// Name of the preset to apply to this participant.
PresetName param.Field[string] `json:"preset_name" api:"required"`
// (Optional) Name of the participant.
Name param.Field[string] `json:"name"`
// (Optional) A URL to a picture to be used for the participant.
Picture param.Field[string] `json:"picture" format:"uri"`
}
func (MeetingAddParticipantParams) MarshalJSON ¶
func (r MeetingAddParticipantParams) MarshalJSON() (data []byte, err error)
type MeetingAddParticipantResponse ¶
type MeetingAddParticipantResponse struct {
// Success status of the operation
Success bool `json:"success" api:"required"`
// Represents a participant.
Data MeetingAddParticipantResponseData `json:"data"`
JSON meetingAddParticipantResponseJSON `json:"-"`
}
func (*MeetingAddParticipantResponse) UnmarshalJSON ¶
func (r *MeetingAddParticipantResponse) UnmarshalJSON(data []byte) (err error)
type MeetingAddParticipantResponseData ¶
type MeetingAddParticipantResponseData struct {
// ID of the participant.
ID string `json:"id" api:"required" format:"uuid"`
// The participant's auth token that can be used for joining a meeting from the
// client side.
Token string `json:"token" api:"required"`
// When this object was created. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// A unique participant ID generated by the client.
CustomParticipantID string `json:"custom_participant_id" api:"required"`
// Preset applied to the participant.
PresetName string `json:"preset_name" api:"required"`
// When this object was updated. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// Name of the participant.
Name string `json:"name" api:"nullable"`
// URL to a picture of the participant.
Picture string `json:"picture" api:"nullable" format:"uri"`
JSON meetingAddParticipantResponseDataJSON `json:"-"`
}
Represents a participant.
func (*MeetingAddParticipantResponseData) UnmarshalJSON ¶
func (r *MeetingAddParticipantResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingDeleteMeetingParticipantResponse ¶
type MeetingDeleteMeetingParticipantResponse struct {
// Success status of the operation
Success bool `json:"success" api:"required"`
// Data returned by the operation
Data MeetingDeleteMeetingParticipantResponseData `json:"data"`
JSON meetingDeleteMeetingParticipantResponseJSON `json:"-"`
}
func (*MeetingDeleteMeetingParticipantResponse) UnmarshalJSON ¶
func (r *MeetingDeleteMeetingParticipantResponse) UnmarshalJSON(data []byte) (err error)
type MeetingDeleteMeetingParticipantResponseData ¶
type MeetingDeleteMeetingParticipantResponseData struct {
// Timestamp this object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// A unique participant ID generated by the client.
CustomParticipantID string `json:"custom_participant_id" api:"required"`
// ID of the preset applied to this participant.
PresetID string `json:"preset_id" api:"required" format:"uuid"`
// Timestamp this object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
JSON meetingDeleteMeetingParticipantResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*MeetingDeleteMeetingParticipantResponseData) UnmarshalJSON ¶
func (r *MeetingDeleteMeetingParticipantResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingEditParticipantParams ¶
type MeetingEditParticipantParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// (Optional) Name of the participant.
Name param.Field[string] `json:"name"`
// (Optional) A URL to a picture to be used for the participant.
Picture param.Field[string] `json:"picture" format:"uri"`
// (Optional) Name of the preset to apply to this participant.
PresetName param.Field[string] `json:"preset_name"`
}
func (MeetingEditParticipantParams) MarshalJSON ¶
func (r MeetingEditParticipantParams) MarshalJSON() (data []byte, err error)
type MeetingEditParticipantResponse ¶
type MeetingEditParticipantResponse struct {
// Success status of the operation
Success bool `json:"success" api:"required"`
// Represents a participant.
Data MeetingEditParticipantResponseData `json:"data"`
JSON meetingEditParticipantResponseJSON `json:"-"`
}
func (*MeetingEditParticipantResponse) UnmarshalJSON ¶
func (r *MeetingEditParticipantResponse) UnmarshalJSON(data []byte) (err error)
type MeetingEditParticipantResponseData ¶
type MeetingEditParticipantResponseData struct {
// ID of the participant.
ID string `json:"id" api:"required" format:"uuid"`
// The participant's auth token that can be used for joining a meeting from the
// client side.
Token string `json:"token" api:"required"`
// When this object was created. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// A unique participant ID generated by the client.
CustomParticipantID string `json:"custom_participant_id" api:"required"`
// Preset applied to the participant.
PresetName string `json:"preset_name" api:"required"`
// When this object was updated. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// Name of the participant.
Name string `json:"name" api:"nullable"`
// URL to a picture of the participant.
Picture string `json:"picture" api:"nullable" format:"uri"`
JSON meetingEditParticipantResponseDataJSON `json:"-"`
}
Represents a participant.
func (*MeetingEditParticipantResponseData) UnmarshalJSON ¶
func (r *MeetingEditParticipantResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDParams ¶
type MeetingGetMeetingByIDParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
Name param.Field[string] `query:"name"`
}
func (MeetingGetMeetingByIDParams) URLQuery ¶
func (r MeetingGetMeetingByIDParams) URLQuery() (v url.Values)
URLQuery serializes MeetingGetMeetingByIDParams's query parameters as `url.Values`.
type MeetingGetMeetingByIDResponse ¶
type MeetingGetMeetingByIDResponse struct {
// Success status of the operation
Success bool `json:"success" api:"required"`
// Data returned by the operation
Data MeetingGetMeetingByIDResponseData `json:"data"`
JSON meetingGetMeetingByIDResponseJSON `json:"-"`
}
func (*MeetingGetMeetingByIDResponse) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponse) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseData ¶
type MeetingGetMeetingByIDResponseData struct {
// ID of the meeting.
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// The AI Config allows you to customize the behavior of meeting transcriptions and
// summaries
AIConfig MeetingGetMeetingByIDResponseDataAIConfig `json:"ai_config"`
// Specifies if the meeting should start getting livestreamed on start.
LiveStreamOnStart bool `json:"live_stream_on_start"`
// Specifies if Chat within a meeting should persist for a week.
PersistChat bool `json:"persist_chat"`
// Specifies if the meeting should start getting recorded as soon as someone joins
// the meeting.
RecordOnStart bool `json:"record_on_start"`
// Recording Configurations to be used for this meeting. This level of configs
// takes higher preference over App level configs on the RealtimeKit developer
// portal.
RecordingConfig MeetingGetMeetingByIDResponseDataRecordingConfig `json:"recording_config"`
// Time in seconds, for which a session remains active, after the last participant
// has left the meeting.
SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
// `INACTIVE` meeting.
Status MeetingGetMeetingByIDResponseDataStatus `json:"status"`
// Automatically generate summary of meetings using transcripts. Requires
// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
SummarizeOnEnd bool `json:"summarize_on_end"`
// Title of the meeting.
Title string `json:"title"`
JSON meetingGetMeetingByIDResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*MeetingGetMeetingByIDResponseData) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataAIConfig ¶
type MeetingGetMeetingByIDResponseDataAIConfig struct {
// Summary Config
Summarization MeetingGetMeetingByIDResponseDataAIConfigSummarization `json:"summarization"`
// Transcription Configurations
Transcription MeetingGetMeetingByIDResponseDataAIConfigTranscription `json:"transcription"`
JSON meetingGetMeetingByIDResponseDataAIConfigJSON `json:"-"`
}
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
func (*MeetingGetMeetingByIDResponseDataAIConfig) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataAIConfig) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataAIConfigSummarization ¶
type MeetingGetMeetingByIDResponseDataAIConfigSummarization struct {
// Defines the style of the summary, such as general, team meeting, or sales call.
SummaryType MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType `json:"summary_type"`
// Determines the text format of the summary, such as plain text or markdown.
TextFormat MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat `json:"text_format"`
// Sets the maximum number of words in the meeting summary.
WordLimit int64 `json:"word_limit"`
JSON meetingGetMeetingByIDResponseDataAIConfigSummarizationJSON `json:"-"`
}
Summary Config
func (*MeetingGetMeetingByIDResponseDataAIConfigSummarization) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataAIConfigSummarization) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType ¶
type MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType string
Defines the style of the summary, such as general, team meeting, or sales call.
const ( MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeGeneral MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "general" MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeTeamMeeting MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "team_meeting" MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeSalesCall MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "sales_call" MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeClientCheckIn MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "client_check_in" MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeInterview MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "interview" MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeDailyStandup MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "daily_standup" MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "one_on_one_meeting" MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeLecture MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "lecture" MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryTypeCodeReview MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType = "code_review" )
func (MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType) IsKnown ¶
func (r MeetingGetMeetingByIDResponseDataAIConfigSummarizationSummaryType) IsKnown() bool
type MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat ¶
type MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat string
Determines the text format of the summary, such as plain text or markdown.
const ( MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormatPlainText MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat = "plain_text" MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormatMarkdown MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat = "markdown" )
func (MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat) IsKnown ¶
func (r MeetingGetMeetingByIDResponseDataAIConfigSummarizationTextFormat) IsKnown() bool
type MeetingGetMeetingByIDResponseDataAIConfigTranscription ¶
type MeetingGetMeetingByIDResponseDataAIConfigTranscription struct {
// Adds specific terms to improve accurate detection during transcription.
Keywords []string `json:"keywords"`
// Specifies the language code for transcription to ensure accurate results.
Language MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage `json:"language"`
// Control the inclusion of offensive language in transcriptions.
ProfanityFilter bool `json:"profanity_filter"`
JSON meetingGetMeetingByIDResponseDataAIConfigTranscriptionJSON `json:"-"`
}
Transcription Configurations
func (*MeetingGetMeetingByIDResponseDataAIConfigTranscription) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataAIConfigTranscription) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage ¶
type MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage string
Specifies the language code for transcription to ensure accurate results.
const ( MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageEnUs MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-US" MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageEnIn MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-IN" MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageDe MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "de" MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageHi MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "hi" MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageSv MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "sv" MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageRu MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "ru" MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguagePl MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "pl" MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageEl MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "el" MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageFr MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "fr" MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguageNl MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage = "nl" )
func (MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage) IsKnown ¶
func (r MeetingGetMeetingByIDResponseDataAIConfigTranscriptionLanguage) IsKnown() bool
type MeetingGetMeetingByIDResponseDataRecordingConfig ¶
type MeetingGetMeetingByIDResponseDataRecordingConfig struct {
// Object containing configuration regarding the audio that is being recorded.
AudioConfig MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfig `json:"audio_config"`
// Adds a prefix to the beginning of the file name of the recording.
FileNamePrefix string `json:"file_name_prefix"`
LiveStreamingConfig MeetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfig `json:"live_streaming_config"`
// Specifies the maximum duration for recording in seconds, ranging from a minimum
// of 60 seconds to a maximum of 24 hours.
MaxSeconds float64 `json:"max_seconds"`
RealtimekitBucketConfig MeetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig `json:"realtimekit_bucket_config"`
StorageConfig MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfig `json:"storage_config" api:"nullable"`
VideoConfig MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfig `json:"video_config"`
JSON meetingGetMeetingByIDResponseDataRecordingConfigJSON `json:"-"`
}
Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
func (*MeetingGetMeetingByIDResponseDataRecordingConfig) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataRecordingConfig) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfig ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfig struct {
// Audio signal pathway within an audio file that carries a specific sound source.
Channel MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel `json:"channel"`
// Codec using which the recording will be encoded. If VP8/VP9 is selected for
// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
// audioConfig is automatically set to vorbis.
Codec MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec `json:"codec"`
// Controls whether to export audio file seperately
ExportFile bool `json:"export_file"`
JSON meetingGetMeetingByIDResponseDataRecordingConfigAudioConfigJSON `json:"-"`
}
Object containing configuration regarding the audio that is being recorded.
func (*MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfig) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfig) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel string
Audio signal pathway within an audio file that carries a specific sound source.
const ( MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannelMono MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "mono" MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannelStereo MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "stereo" )
func (MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel) IsKnown ¶
func (r MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigChannel) IsKnown() bool
type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec string
Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.
const ( MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodecMP3 MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "MP3" MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodecAac MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "AAC" )
func (MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec) IsKnown ¶
func (r MeetingGetMeetingByIDResponseDataRecordingConfigAudioConfigCodec) IsKnown() bool
type MeetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfig ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfig struct {
// RTMP URL to stream to
RtmpURL string `json:"rtmp_url" format:"uri"`
JSON meetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfigJSON `json:"-"`
}
func (*MeetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig struct {
// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
// generated for a recording.
Enabled bool `json:"enabled" api:"required"`
JSON meetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfigJSON `json:"-"`
}
func (*MeetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfig ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfig struct {
// Type of storage media.
Type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType `json:"type" api:"required"`
// Authentication method used for "sftp" type storage medium
AuthMethod MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket string `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host string `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password string `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path string `json:"path"`
// SSH destination server port for SFTP type storage medium
Port float64 `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey string `json:"private_key"`
// Region of the storage medium.
Region string `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret string `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username string `json:"username"`
JSON meetingGetMeetingByIDResponseDataRecordingConfigStorageConfigJSON `json:"-"`
}
func (*MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfig) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfig) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodKey MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "KEY" MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodPassword MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "PASSWORD" )
func (MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown ¶
func (r MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown() bool
type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType string
Type of storage media.
const ( MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigTypeAws MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType = "aws" MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigTypeAzure MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType = "azure" MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigTypeDigitalocean MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType = "digitalocean" MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigTypeGcs MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType = "gcs" MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigTypeSftp MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType = "sftp" )
func (MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType) IsKnown ¶
func (r MeetingGetMeetingByIDResponseDataRecordingConfigStorageConfigType) IsKnown() bool
type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfig ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfig struct {
// Codec using which the recording will be encoded.
Codec MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec `json:"codec"`
// Controls whether to export video file seperately
ExportFile bool `json:"export_file"`
// Height of the recording video in pixels
Height int64 `json:"height"`
// Watermark to be added to the recording
Watermark MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermark `json:"watermark"`
// Width of the recording video in pixels
Width int64 `json:"width"`
JSON meetingGetMeetingByIDResponseDataRecordingConfigVideoConfigJSON `json:"-"`
}
func (*MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfig) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfig) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec string
Codec using which the recording will be encoded.
const ( MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodecH264 MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "H264" MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodecVp8 MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "VP8" )
func (MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec) IsKnown ¶
func (r MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigCodec) IsKnown() bool
type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermark ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermark struct {
// Position of the watermark
Position MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition `json:"position"`
// Size of the watermark
Size MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize `json:"size"`
// URL of the watermark image
URL string `json:"url" format:"uri"`
JSON meetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkJSON `json:"-"`
}
Watermark to be added to the recording
func (*MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition string
Position of the watermark
const ( MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftTop MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left top" MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightTop MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right top" MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftBottom MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left bottom" MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right bottom" )
func (MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition) IsKnown ¶
func (r MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition) IsKnown() bool
type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize ¶
type MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize struct {
// Height of the watermark in px
Height int64 `json:"height"`
// Width of the watermark in px
Width int64 `json:"width"`
JSON meetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSizeJSON `json:"-"`
}
Size of the watermark
func (*MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON ¶
func (r *MeetingGetMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingByIDResponseDataStatus ¶
type MeetingGetMeetingByIDResponseDataStatus string
Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.
const ( MeetingGetMeetingByIDResponseDataStatusActive MeetingGetMeetingByIDResponseDataStatus = "ACTIVE" MeetingGetMeetingByIDResponseDataStatusInactive MeetingGetMeetingByIDResponseDataStatus = "INACTIVE" )
func (MeetingGetMeetingByIDResponseDataStatus) IsKnown ¶
func (r MeetingGetMeetingByIDResponseDataStatus) IsKnown() bool
type MeetingGetMeetingParticipantResponse ¶
type MeetingGetMeetingParticipantResponse struct {
// Data returned by the operation
Data MeetingGetMeetingParticipantResponseData `json:"data" api:"required"`
// Success status of the operation
Success bool `json:"success" api:"required"`
JSON meetingGetMeetingParticipantResponseJSON `json:"-"`
}
func (*MeetingGetMeetingParticipantResponse) UnmarshalJSON ¶
func (r *MeetingGetMeetingParticipantResponse) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingParticipantResponseData ¶
type MeetingGetMeetingParticipantResponseData struct {
// ID of the participant.
ID string `json:"id" api:"required" format:"uuid"`
// When this object was created. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// A unique participant ID generated by the client.
CustomParticipantID string `json:"custom_participant_id" api:"required"`
// Preset applied to the participant.
PresetName string `json:"preset_name" api:"required"`
// When this object was updated. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// Name of the participant.
Name string `json:"name" api:"nullable"`
// URL to a picture of the participant.
Picture string `json:"picture" api:"nullable" format:"uri"`
JSON meetingGetMeetingParticipantResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*MeetingGetMeetingParticipantResponseData) UnmarshalJSON ¶
func (r *MeetingGetMeetingParticipantResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingParticipantsParams ¶
type MeetingGetMeetingParticipantsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// The page number from which you want your page search results to be displayed.
PageNo param.Field[float64] `query:"page_no"`
// Number of results per page
PerPage param.Field[float64] `query:"per_page"`
}
func (MeetingGetMeetingParticipantsParams) URLQuery ¶
func (r MeetingGetMeetingParticipantsParams) URLQuery() (v url.Values)
URLQuery serializes MeetingGetMeetingParticipantsParams's query parameters as `url.Values`.
type MeetingGetMeetingParticipantsResponse ¶
type MeetingGetMeetingParticipantsResponse struct {
Data []MeetingGetMeetingParticipantsResponseData `json:"data" api:"required"`
Paging MeetingGetMeetingParticipantsResponsePaging `json:"paging" api:"required"`
Success bool `json:"success" api:"required"`
JSON meetingGetMeetingParticipantsResponseJSON `json:"-"`
}
func (*MeetingGetMeetingParticipantsResponse) UnmarshalJSON ¶
func (r *MeetingGetMeetingParticipantsResponse) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingParticipantsResponseData ¶
type MeetingGetMeetingParticipantsResponseData struct {
// ID of the participant.
ID string `json:"id" api:"required" format:"uuid"`
// When this object was created. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// A unique participant ID generated by the client.
CustomParticipantID string `json:"custom_participant_id" api:"required"`
// Preset applied to the participant.
PresetName string `json:"preset_name" api:"required"`
// When this object was updated. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// Name of the participant.
Name string `json:"name" api:"nullable"`
// URL to a picture of the participant.
Picture string `json:"picture" api:"nullable" format:"uri"`
JSON meetingGetMeetingParticipantsResponseDataJSON `json:"-"`
}
Represents a participant.
func (*MeetingGetMeetingParticipantsResponseData) UnmarshalJSON ¶
func (r *MeetingGetMeetingParticipantsResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingGetMeetingParticipantsResponsePaging ¶
type MeetingGetMeetingParticipantsResponsePaging struct {
EndOffset float64 `json:"end_offset" api:"required"`
StartOffset float64 `json:"start_offset" api:"required"`
TotalCount float64 `json:"total_count" api:"required"`
JSON meetingGetMeetingParticipantsResponsePagingJSON `json:"-"`
}
func (*MeetingGetMeetingParticipantsResponsePaging) UnmarshalJSON ¶
func (r *MeetingGetMeetingParticipantsResponsePaging) UnmarshalJSON(data []byte) (err error)
type MeetingGetParams ¶
type MeetingGetParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// The end time range for which you want to retrieve the meetings. The time must be
// specified in ISO format.
EndTime param.Field[time.Time] `query:"end_time" format:"date-time"`
// The page number from which you want your page search results to be displayed.
PageNo param.Field[float64] `query:"page_no"`
// Number of results per page
PerPage param.Field[float64] `query:"per_page"`
// The search query string. You can search using the meeting ID or title.
Search param.Field[string] `query:"search"`
// The start time range for which you want to retrieve the meetings. The time must
// be specified in ISO format.
StartTime param.Field[time.Time] `query:"start_time" format:"date-time"`
}
func (MeetingGetParams) URLQuery ¶
func (r MeetingGetParams) URLQuery() (v url.Values)
URLQuery serializes MeetingGetParams's query parameters as `url.Values`.
type MeetingGetResponse ¶
type MeetingGetResponse struct {
Data []MeetingGetResponseData `json:"data" api:"required"`
Paging MeetingGetResponsePaging `json:"paging" api:"required"`
Success bool `json:"success" api:"required"`
JSON meetingGetResponseJSON `json:"-"`
}
func (*MeetingGetResponse) UnmarshalJSON ¶
func (r *MeetingGetResponse) UnmarshalJSON(data []byte) (err error)
type MeetingGetResponseData ¶
type MeetingGetResponseData struct {
// ID of the meeting.
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// Specifies if the meeting should start getting livestreamed on start.
LiveStreamOnStart bool `json:"live_stream_on_start"`
// Specifies if Chat within a meeting should persist for a week.
PersistChat bool `json:"persist_chat"`
// Specifies if the meeting should start getting recorded as soon as someone joins
// the meeting.
RecordOnStart bool `json:"record_on_start"`
// Time in seconds, for which a session remains active, after the last participant
// has left the meeting.
SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
// `INACTIVE` meeting.
Status MeetingGetResponseDataStatus `json:"status"`
// Automatically generate summary of meetings using transcripts. Requires
// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
SummarizeOnEnd bool `json:"summarize_on_end"`
// Title of the meeting.
Title string `json:"title"`
JSON meetingGetResponseDataJSON `json:"-"`
}
func (*MeetingGetResponseData) UnmarshalJSON ¶
func (r *MeetingGetResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingGetResponseDataStatus ¶
type MeetingGetResponseDataStatus string
Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.
const ( MeetingGetResponseDataStatusActive MeetingGetResponseDataStatus = "ACTIVE" MeetingGetResponseDataStatusInactive MeetingGetResponseDataStatus = "INACTIVE" )
func (MeetingGetResponseDataStatus) IsKnown ¶
func (r MeetingGetResponseDataStatus) IsKnown() bool
type MeetingGetResponsePaging ¶
type MeetingGetResponsePaging struct {
EndOffset float64 `json:"end_offset" api:"required"`
StartOffset float64 `json:"start_offset" api:"required"`
TotalCount float64 `json:"total_count" api:"required"`
JSON meetingGetResponsePagingJSON `json:"-"`
}
func (*MeetingGetResponsePaging) UnmarshalJSON ¶
func (r *MeetingGetResponsePaging) UnmarshalJSON(data []byte) (err error)
type MeetingNewParams ¶
type MeetingNewParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// The AI Config allows you to customize the behavior of meeting transcriptions and
// summaries
AIConfig param.Field[MeetingNewParamsAIConfig] `json:"ai_config"`
// Specifies if the meeting should start getting livestreamed on start.
LiveStreamOnStart param.Field[bool] `json:"live_stream_on_start"`
// If a meeting is set to persist_chat, meeting chat would remain for a week within
// the meeting space.
PersistChat param.Field[bool] `json:"persist_chat"`
// Specifies if the meeting should start getting recorded as soon as someone joins
// the meeting.
RecordOnStart param.Field[bool] `json:"record_on_start"`
// Recording Configurations to be used for this meeting. This level of configs
// takes higher preference over App level configs on the RealtimeKit developer
// portal.
RecordingConfig param.Field[MeetingNewParamsRecordingConfig] `json:"recording_config"`
// Time in seconds, for which a session remains active, after the last participant
// has left the meeting.
SessionKeepAliveTimeInSecs param.Field[float64] `json:"session_keep_alive_time_in_secs"`
// Automatically generate summary of meetings using transcripts. Requires
// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
SummarizeOnEnd param.Field[bool] `json:"summarize_on_end"`
// Title of the meeting
Title param.Field[string] `json:"title"`
}
func (MeetingNewParams) MarshalJSON ¶
func (r MeetingNewParams) MarshalJSON() (data []byte, err error)
type MeetingNewParamsAIConfig ¶
type MeetingNewParamsAIConfig struct {
// Summary Config
Summarization param.Field[MeetingNewParamsAIConfigSummarization] `json:"summarization"`
// Transcription Configurations
Transcription param.Field[MeetingNewParamsAIConfigTranscription] `json:"transcription"`
}
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
func (MeetingNewParamsAIConfig) MarshalJSON ¶
func (r MeetingNewParamsAIConfig) MarshalJSON() (data []byte, err error)
type MeetingNewParamsAIConfigSummarization ¶
type MeetingNewParamsAIConfigSummarization struct {
// Defines the style of the summary, such as general, team meeting, or sales call.
SummaryType param.Field[MeetingNewParamsAIConfigSummarizationSummaryType] `json:"summary_type"`
// Determines the text format of the summary, such as plain text or markdown.
TextFormat param.Field[MeetingNewParamsAIConfigSummarizationTextFormat] `json:"text_format"`
// Sets the maximum number of words in the meeting summary.
WordLimit param.Field[int64] `json:"word_limit"`
}
Summary Config
func (MeetingNewParamsAIConfigSummarization) MarshalJSON ¶
func (r MeetingNewParamsAIConfigSummarization) MarshalJSON() (data []byte, err error)
type MeetingNewParamsAIConfigSummarizationSummaryType ¶
type MeetingNewParamsAIConfigSummarizationSummaryType string
Defines the style of the summary, such as general, team meeting, or sales call.
const ( MeetingNewParamsAIConfigSummarizationSummaryTypeGeneral MeetingNewParamsAIConfigSummarizationSummaryType = "general" MeetingNewParamsAIConfigSummarizationSummaryTypeTeamMeeting MeetingNewParamsAIConfigSummarizationSummaryType = "team_meeting" MeetingNewParamsAIConfigSummarizationSummaryTypeSalesCall MeetingNewParamsAIConfigSummarizationSummaryType = "sales_call" MeetingNewParamsAIConfigSummarizationSummaryTypeClientCheckIn MeetingNewParamsAIConfigSummarizationSummaryType = "client_check_in" MeetingNewParamsAIConfigSummarizationSummaryTypeInterview MeetingNewParamsAIConfigSummarizationSummaryType = "interview" MeetingNewParamsAIConfigSummarizationSummaryTypeDailyStandup MeetingNewParamsAIConfigSummarizationSummaryType = "daily_standup" MeetingNewParamsAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingNewParamsAIConfigSummarizationSummaryType = "one_on_one_meeting" MeetingNewParamsAIConfigSummarizationSummaryTypeLecture MeetingNewParamsAIConfigSummarizationSummaryType = "lecture" MeetingNewParamsAIConfigSummarizationSummaryTypeCodeReview MeetingNewParamsAIConfigSummarizationSummaryType = "code_review" )
func (MeetingNewParamsAIConfigSummarizationSummaryType) IsKnown ¶
func (r MeetingNewParamsAIConfigSummarizationSummaryType) IsKnown() bool
type MeetingNewParamsAIConfigSummarizationTextFormat ¶
type MeetingNewParamsAIConfigSummarizationTextFormat string
Determines the text format of the summary, such as plain text or markdown.
const ( MeetingNewParamsAIConfigSummarizationTextFormatPlainText MeetingNewParamsAIConfigSummarizationTextFormat = "plain_text" MeetingNewParamsAIConfigSummarizationTextFormatMarkdown MeetingNewParamsAIConfigSummarizationTextFormat = "markdown" )
func (MeetingNewParamsAIConfigSummarizationTextFormat) IsKnown ¶
func (r MeetingNewParamsAIConfigSummarizationTextFormat) IsKnown() bool
type MeetingNewParamsAIConfigTranscription ¶
type MeetingNewParamsAIConfigTranscription struct {
// Adds specific terms to improve accurate detection during transcription.
Keywords param.Field[[]string] `json:"keywords"`
// Specifies the language code for transcription to ensure accurate results.
Language param.Field[MeetingNewParamsAIConfigTranscriptionLanguage] `json:"language"`
// Control the inclusion of offensive language in transcriptions.
ProfanityFilter param.Field[bool] `json:"profanity_filter"`
}
Transcription Configurations
func (MeetingNewParamsAIConfigTranscription) MarshalJSON ¶
func (r MeetingNewParamsAIConfigTranscription) MarshalJSON() (data []byte, err error)
type MeetingNewParamsAIConfigTranscriptionLanguage ¶
type MeetingNewParamsAIConfigTranscriptionLanguage string
Specifies the language code for transcription to ensure accurate results.
const ( MeetingNewParamsAIConfigTranscriptionLanguageEnUs MeetingNewParamsAIConfigTranscriptionLanguage = "en-US" MeetingNewParamsAIConfigTranscriptionLanguageEnIn MeetingNewParamsAIConfigTranscriptionLanguage = "en-IN" MeetingNewParamsAIConfigTranscriptionLanguageDe MeetingNewParamsAIConfigTranscriptionLanguage = "de" MeetingNewParamsAIConfigTranscriptionLanguageHi MeetingNewParamsAIConfigTranscriptionLanguage = "hi" MeetingNewParamsAIConfigTranscriptionLanguageSv MeetingNewParamsAIConfigTranscriptionLanguage = "sv" MeetingNewParamsAIConfigTranscriptionLanguageRu MeetingNewParamsAIConfigTranscriptionLanguage = "ru" MeetingNewParamsAIConfigTranscriptionLanguagePl MeetingNewParamsAIConfigTranscriptionLanguage = "pl" MeetingNewParamsAIConfigTranscriptionLanguageEl MeetingNewParamsAIConfigTranscriptionLanguage = "el" MeetingNewParamsAIConfigTranscriptionLanguageFr MeetingNewParamsAIConfigTranscriptionLanguage = "fr" MeetingNewParamsAIConfigTranscriptionLanguageNl MeetingNewParamsAIConfigTranscriptionLanguage = "nl" )
func (MeetingNewParamsAIConfigTranscriptionLanguage) IsKnown ¶
func (r MeetingNewParamsAIConfigTranscriptionLanguage) IsKnown() bool
type MeetingNewParamsRecordingConfig ¶
type MeetingNewParamsRecordingConfig struct {
// Object containing configuration regarding the audio that is being recorded.
AudioConfig param.Field[MeetingNewParamsRecordingConfigAudioConfig] `json:"audio_config"`
// Adds a prefix to the beginning of the file name of the recording.
FileNamePrefix param.Field[string] `json:"file_name_prefix"`
LiveStreamingConfig param.Field[MeetingNewParamsRecordingConfigLiveStreamingConfig] `json:"live_streaming_config"`
// Specifies the maximum duration for recording in seconds, ranging from a minimum
// of 60 seconds to a maximum of 24 hours.
MaxSeconds param.Field[float64] `json:"max_seconds"`
RealtimekitBucketConfig param.Field[MeetingNewParamsRecordingConfigRealtimekitBucketConfig] `json:"realtimekit_bucket_config"`
StorageConfig param.Field[MeetingNewParamsRecordingConfigStorageConfig] `json:"storage_config"`
VideoConfig param.Field[MeetingNewParamsRecordingConfigVideoConfig] `json:"video_config"`
}
Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
func (MeetingNewParamsRecordingConfig) MarshalJSON ¶
func (r MeetingNewParamsRecordingConfig) MarshalJSON() (data []byte, err error)
type MeetingNewParamsRecordingConfigAudioConfig ¶
type MeetingNewParamsRecordingConfigAudioConfig struct {
// Audio signal pathway within an audio file that carries a specific sound source.
Channel param.Field[MeetingNewParamsRecordingConfigAudioConfigChannel] `json:"channel"`
// Codec using which the recording will be encoded. If VP8/VP9 is selected for
// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
// audioConfig is automatically set to vorbis.
Codec param.Field[MeetingNewParamsRecordingConfigAudioConfigCodec] `json:"codec"`
// Controls whether to export audio file seperately
ExportFile param.Field[bool] `json:"export_file"`
}
Object containing configuration regarding the audio that is being recorded.
func (MeetingNewParamsRecordingConfigAudioConfig) MarshalJSON ¶
func (r MeetingNewParamsRecordingConfigAudioConfig) MarshalJSON() (data []byte, err error)
type MeetingNewParamsRecordingConfigAudioConfigChannel ¶
type MeetingNewParamsRecordingConfigAudioConfigChannel string
Audio signal pathway within an audio file that carries a specific sound source.
const ( MeetingNewParamsRecordingConfigAudioConfigChannelMono MeetingNewParamsRecordingConfigAudioConfigChannel = "mono" MeetingNewParamsRecordingConfigAudioConfigChannelStereo MeetingNewParamsRecordingConfigAudioConfigChannel = "stereo" )
func (MeetingNewParamsRecordingConfigAudioConfigChannel) IsKnown ¶
func (r MeetingNewParamsRecordingConfigAudioConfigChannel) IsKnown() bool
type MeetingNewParamsRecordingConfigAudioConfigCodec ¶
type MeetingNewParamsRecordingConfigAudioConfigCodec string
Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.
const ( MeetingNewParamsRecordingConfigAudioConfigCodecMP3 MeetingNewParamsRecordingConfigAudioConfigCodec = "MP3" MeetingNewParamsRecordingConfigAudioConfigCodecAac MeetingNewParamsRecordingConfigAudioConfigCodec = "AAC" )
func (MeetingNewParamsRecordingConfigAudioConfigCodec) IsKnown ¶
func (r MeetingNewParamsRecordingConfigAudioConfigCodec) IsKnown() bool
type MeetingNewParamsRecordingConfigLiveStreamingConfig ¶
type MeetingNewParamsRecordingConfigLiveStreamingConfig struct {
// RTMP URL to stream to
RtmpURL param.Field[string] `json:"rtmp_url" format:"uri"`
}
func (MeetingNewParamsRecordingConfigLiveStreamingConfig) MarshalJSON ¶
func (r MeetingNewParamsRecordingConfigLiveStreamingConfig) MarshalJSON() (data []byte, err error)
type MeetingNewParamsRecordingConfigRealtimekitBucketConfig ¶
type MeetingNewParamsRecordingConfigRealtimekitBucketConfig struct {
// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
// generated for a recording.
Enabled param.Field[bool] `json:"enabled" api:"required"`
}
func (MeetingNewParamsRecordingConfigRealtimekitBucketConfig) MarshalJSON ¶
func (r MeetingNewParamsRecordingConfigRealtimekitBucketConfig) MarshalJSON() (data []byte, err error)
type MeetingNewParamsRecordingConfigStorageConfig ¶
type MeetingNewParamsRecordingConfigStorageConfig struct {
// Type of storage media.
Type param.Field[MeetingNewParamsRecordingConfigStorageConfigType] `json:"type" api:"required"`
// Access key of the storage medium. Access key is not required for the `gcs`
// storage media type.
//
// Note that this field is not readable by clients, only writeable.
AccessKey param.Field[string] `json:"access_key"`
// Authentication method used for "sftp" type storage medium
AuthMethod param.Field[MeetingNewParamsRecordingConfigStorageConfigAuthMethod] `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket param.Field[string] `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host param.Field[string] `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password param.Field[string] `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path param.Field[string] `json:"path"`
// SSH destination server port for SFTP type storage medium
Port param.Field[float64] `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey param.Field[string] `json:"private_key"`
// Region of the storage medium.
Region param.Field[string] `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret param.Field[string] `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username param.Field[string] `json:"username"`
}
func (MeetingNewParamsRecordingConfigStorageConfig) MarshalJSON ¶
func (r MeetingNewParamsRecordingConfigStorageConfig) MarshalJSON() (data []byte, err error)
type MeetingNewParamsRecordingConfigStorageConfigAuthMethod ¶
type MeetingNewParamsRecordingConfigStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( MeetingNewParamsRecordingConfigStorageConfigAuthMethodKey MeetingNewParamsRecordingConfigStorageConfigAuthMethod = "KEY" MeetingNewParamsRecordingConfigStorageConfigAuthMethodPassword MeetingNewParamsRecordingConfigStorageConfigAuthMethod = "PASSWORD" )
func (MeetingNewParamsRecordingConfigStorageConfigAuthMethod) IsKnown ¶
func (r MeetingNewParamsRecordingConfigStorageConfigAuthMethod) IsKnown() bool
type MeetingNewParamsRecordingConfigStorageConfigType ¶
type MeetingNewParamsRecordingConfigStorageConfigType string
Type of storage media.
const ( MeetingNewParamsRecordingConfigStorageConfigTypeAws MeetingNewParamsRecordingConfigStorageConfigType = "aws" MeetingNewParamsRecordingConfigStorageConfigTypeAzure MeetingNewParamsRecordingConfigStorageConfigType = "azure" MeetingNewParamsRecordingConfigStorageConfigTypeDigitalocean MeetingNewParamsRecordingConfigStorageConfigType = "digitalocean" MeetingNewParamsRecordingConfigStorageConfigTypeGcs MeetingNewParamsRecordingConfigStorageConfigType = "gcs" MeetingNewParamsRecordingConfigStorageConfigTypeSftp MeetingNewParamsRecordingConfigStorageConfigType = "sftp" )
func (MeetingNewParamsRecordingConfigStorageConfigType) IsKnown ¶
func (r MeetingNewParamsRecordingConfigStorageConfigType) IsKnown() bool
type MeetingNewParamsRecordingConfigVideoConfig ¶
type MeetingNewParamsRecordingConfigVideoConfig struct {
// Codec using which the recording will be encoded.
Codec param.Field[MeetingNewParamsRecordingConfigVideoConfigCodec] `json:"codec"`
// Controls whether to export video file seperately
ExportFile param.Field[bool] `json:"export_file"`
// Height of the recording video in pixels
Height param.Field[int64] `json:"height"`
// Watermark to be added to the recording
Watermark param.Field[MeetingNewParamsRecordingConfigVideoConfigWatermark] `json:"watermark"`
// Width of the recording video in pixels
Width param.Field[int64] `json:"width"`
}
func (MeetingNewParamsRecordingConfigVideoConfig) MarshalJSON ¶
func (r MeetingNewParamsRecordingConfigVideoConfig) MarshalJSON() (data []byte, err error)
type MeetingNewParamsRecordingConfigVideoConfigCodec ¶
type MeetingNewParamsRecordingConfigVideoConfigCodec string
Codec using which the recording will be encoded.
const ( MeetingNewParamsRecordingConfigVideoConfigCodecH264 MeetingNewParamsRecordingConfigVideoConfigCodec = "H264" MeetingNewParamsRecordingConfigVideoConfigCodecVp8 MeetingNewParamsRecordingConfigVideoConfigCodec = "VP8" )
func (MeetingNewParamsRecordingConfigVideoConfigCodec) IsKnown ¶
func (r MeetingNewParamsRecordingConfigVideoConfigCodec) IsKnown() bool
type MeetingNewParamsRecordingConfigVideoConfigWatermark ¶
type MeetingNewParamsRecordingConfigVideoConfigWatermark struct {
// Position of the watermark
Position param.Field[MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition] `json:"position"`
// Size of the watermark
Size param.Field[MeetingNewParamsRecordingConfigVideoConfigWatermarkSize] `json:"size"`
// URL of the watermark image
URL param.Field[string] `json:"url" format:"uri"`
}
Watermark to be added to the recording
func (MeetingNewParamsRecordingConfigVideoConfigWatermark) MarshalJSON ¶
func (r MeetingNewParamsRecordingConfigVideoConfigWatermark) MarshalJSON() (data []byte, err error)
type MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition ¶
type MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition string
Position of the watermark
const ( MeetingNewParamsRecordingConfigVideoConfigWatermarkPositionLeftTop MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition = "left top" MeetingNewParamsRecordingConfigVideoConfigWatermarkPositionRightTop MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition = "right top" MeetingNewParamsRecordingConfigVideoConfigWatermarkPositionLeftBottom MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition = "left bottom" MeetingNewParamsRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition = "right bottom" )
func (MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition) IsKnown ¶
func (r MeetingNewParamsRecordingConfigVideoConfigWatermarkPosition) IsKnown() bool
type MeetingNewParamsRecordingConfigVideoConfigWatermarkSize ¶
type MeetingNewParamsRecordingConfigVideoConfigWatermarkSize struct {
// Height of the watermark in px
Height param.Field[int64] `json:"height"`
// Width of the watermark in px
Width param.Field[int64] `json:"width"`
}
Size of the watermark
func (MeetingNewParamsRecordingConfigVideoConfigWatermarkSize) MarshalJSON ¶
func (r MeetingNewParamsRecordingConfigVideoConfigWatermarkSize) MarshalJSON() (data []byte, err error)
type MeetingNewResponse ¶
type MeetingNewResponse struct {
// Success status of the operation
Success bool `json:"success" api:"required"`
// Data returned by the operation
Data MeetingNewResponseData `json:"data"`
JSON meetingNewResponseJSON `json:"-"`
}
func (*MeetingNewResponse) UnmarshalJSON ¶
func (r *MeetingNewResponse) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseData ¶
type MeetingNewResponseData struct {
// ID of the meeting.
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// The AI Config allows you to customize the behavior of meeting transcriptions and
// summaries
AIConfig MeetingNewResponseDataAIConfig `json:"ai_config"`
// Specifies if the meeting should start getting livestreamed on start.
LiveStreamOnStart bool `json:"live_stream_on_start"`
// Specifies if Chat within a meeting should persist for a week.
PersistChat bool `json:"persist_chat"`
// Specifies if the meeting should start getting recorded as soon as someone joins
// the meeting.
RecordOnStart bool `json:"record_on_start"`
// Recording Configurations to be used for this meeting. This level of configs
// takes higher preference over App level configs on the RealtimeKit developer
// portal.
RecordingConfig MeetingNewResponseDataRecordingConfig `json:"recording_config"`
// Time in seconds, for which a session remains active, after the last participant
// has left the meeting.
SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
// `INACTIVE` meeting.
Status MeetingNewResponseDataStatus `json:"status"`
// Automatically generate summary of meetings using transcripts. Requires
// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
SummarizeOnEnd bool `json:"summarize_on_end"`
// Title of the meeting.
Title string `json:"title"`
JSON meetingNewResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*MeetingNewResponseData) UnmarshalJSON ¶
func (r *MeetingNewResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataAIConfig ¶
type MeetingNewResponseDataAIConfig struct {
// Summary Config
Summarization MeetingNewResponseDataAIConfigSummarization `json:"summarization"`
// Transcription Configurations
Transcription MeetingNewResponseDataAIConfigTranscription `json:"transcription"`
JSON meetingNewResponseDataAIConfigJSON `json:"-"`
}
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
func (*MeetingNewResponseDataAIConfig) UnmarshalJSON ¶
func (r *MeetingNewResponseDataAIConfig) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataAIConfigSummarization ¶
type MeetingNewResponseDataAIConfigSummarization struct {
// Defines the style of the summary, such as general, team meeting, or sales call.
SummaryType MeetingNewResponseDataAIConfigSummarizationSummaryType `json:"summary_type"`
// Determines the text format of the summary, such as plain text or markdown.
TextFormat MeetingNewResponseDataAIConfigSummarizationTextFormat `json:"text_format"`
// Sets the maximum number of words in the meeting summary.
WordLimit int64 `json:"word_limit"`
JSON meetingNewResponseDataAIConfigSummarizationJSON `json:"-"`
}
Summary Config
func (*MeetingNewResponseDataAIConfigSummarization) UnmarshalJSON ¶
func (r *MeetingNewResponseDataAIConfigSummarization) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataAIConfigSummarizationSummaryType ¶
type MeetingNewResponseDataAIConfigSummarizationSummaryType string
Defines the style of the summary, such as general, team meeting, or sales call.
const ( MeetingNewResponseDataAIConfigSummarizationSummaryTypeGeneral MeetingNewResponseDataAIConfigSummarizationSummaryType = "general" MeetingNewResponseDataAIConfigSummarizationSummaryTypeTeamMeeting MeetingNewResponseDataAIConfigSummarizationSummaryType = "team_meeting" MeetingNewResponseDataAIConfigSummarizationSummaryTypeSalesCall MeetingNewResponseDataAIConfigSummarizationSummaryType = "sales_call" MeetingNewResponseDataAIConfigSummarizationSummaryTypeClientCheckIn MeetingNewResponseDataAIConfigSummarizationSummaryType = "client_check_in" MeetingNewResponseDataAIConfigSummarizationSummaryTypeInterview MeetingNewResponseDataAIConfigSummarizationSummaryType = "interview" MeetingNewResponseDataAIConfigSummarizationSummaryTypeDailyStandup MeetingNewResponseDataAIConfigSummarizationSummaryType = "daily_standup" MeetingNewResponseDataAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingNewResponseDataAIConfigSummarizationSummaryType = "one_on_one_meeting" MeetingNewResponseDataAIConfigSummarizationSummaryTypeLecture MeetingNewResponseDataAIConfigSummarizationSummaryType = "lecture" MeetingNewResponseDataAIConfigSummarizationSummaryTypeCodeReview MeetingNewResponseDataAIConfigSummarizationSummaryType = "code_review" )
func (MeetingNewResponseDataAIConfigSummarizationSummaryType) IsKnown ¶
func (r MeetingNewResponseDataAIConfigSummarizationSummaryType) IsKnown() bool
type MeetingNewResponseDataAIConfigSummarizationTextFormat ¶
type MeetingNewResponseDataAIConfigSummarizationTextFormat string
Determines the text format of the summary, such as plain text or markdown.
const ( MeetingNewResponseDataAIConfigSummarizationTextFormatPlainText MeetingNewResponseDataAIConfigSummarizationTextFormat = "plain_text" MeetingNewResponseDataAIConfigSummarizationTextFormatMarkdown MeetingNewResponseDataAIConfigSummarizationTextFormat = "markdown" )
func (MeetingNewResponseDataAIConfigSummarizationTextFormat) IsKnown ¶
func (r MeetingNewResponseDataAIConfigSummarizationTextFormat) IsKnown() bool
type MeetingNewResponseDataAIConfigTranscription ¶
type MeetingNewResponseDataAIConfigTranscription struct {
// Adds specific terms to improve accurate detection during transcription.
Keywords []string `json:"keywords"`
// Specifies the language code for transcription to ensure accurate results.
Language MeetingNewResponseDataAIConfigTranscriptionLanguage `json:"language"`
// Control the inclusion of offensive language in transcriptions.
ProfanityFilter bool `json:"profanity_filter"`
JSON meetingNewResponseDataAIConfigTranscriptionJSON `json:"-"`
}
Transcription Configurations
func (*MeetingNewResponseDataAIConfigTranscription) UnmarshalJSON ¶
func (r *MeetingNewResponseDataAIConfigTranscription) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataAIConfigTranscriptionLanguage ¶
type MeetingNewResponseDataAIConfigTranscriptionLanguage string
Specifies the language code for transcription to ensure accurate results.
const ( MeetingNewResponseDataAIConfigTranscriptionLanguageEnUs MeetingNewResponseDataAIConfigTranscriptionLanguage = "en-US" MeetingNewResponseDataAIConfigTranscriptionLanguageEnIn MeetingNewResponseDataAIConfigTranscriptionLanguage = "en-IN" MeetingNewResponseDataAIConfigTranscriptionLanguageDe MeetingNewResponseDataAIConfigTranscriptionLanguage = "de" MeetingNewResponseDataAIConfigTranscriptionLanguageHi MeetingNewResponseDataAIConfigTranscriptionLanguage = "hi" MeetingNewResponseDataAIConfigTranscriptionLanguageSv MeetingNewResponseDataAIConfigTranscriptionLanguage = "sv" MeetingNewResponseDataAIConfigTranscriptionLanguageRu MeetingNewResponseDataAIConfigTranscriptionLanguage = "ru" MeetingNewResponseDataAIConfigTranscriptionLanguagePl MeetingNewResponseDataAIConfigTranscriptionLanguage = "pl" MeetingNewResponseDataAIConfigTranscriptionLanguageEl MeetingNewResponseDataAIConfigTranscriptionLanguage = "el" MeetingNewResponseDataAIConfigTranscriptionLanguageFr MeetingNewResponseDataAIConfigTranscriptionLanguage = "fr" MeetingNewResponseDataAIConfigTranscriptionLanguageNl MeetingNewResponseDataAIConfigTranscriptionLanguage = "nl" )
func (MeetingNewResponseDataAIConfigTranscriptionLanguage) IsKnown ¶
func (r MeetingNewResponseDataAIConfigTranscriptionLanguage) IsKnown() bool
type MeetingNewResponseDataRecordingConfig ¶
type MeetingNewResponseDataRecordingConfig struct {
// Object containing configuration regarding the audio that is being recorded.
AudioConfig MeetingNewResponseDataRecordingConfigAudioConfig `json:"audio_config"`
// Adds a prefix to the beginning of the file name of the recording.
FileNamePrefix string `json:"file_name_prefix"`
LiveStreamingConfig MeetingNewResponseDataRecordingConfigLiveStreamingConfig `json:"live_streaming_config"`
// Specifies the maximum duration for recording in seconds, ranging from a minimum
// of 60 seconds to a maximum of 24 hours.
MaxSeconds float64 `json:"max_seconds"`
RealtimekitBucketConfig MeetingNewResponseDataRecordingConfigRealtimekitBucketConfig `json:"realtimekit_bucket_config"`
StorageConfig MeetingNewResponseDataRecordingConfigStorageConfig `json:"storage_config" api:"nullable"`
VideoConfig MeetingNewResponseDataRecordingConfigVideoConfig `json:"video_config"`
JSON meetingNewResponseDataRecordingConfigJSON `json:"-"`
}
Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
func (*MeetingNewResponseDataRecordingConfig) UnmarshalJSON ¶
func (r *MeetingNewResponseDataRecordingConfig) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataRecordingConfigAudioConfig ¶
type MeetingNewResponseDataRecordingConfigAudioConfig struct {
// Audio signal pathway within an audio file that carries a specific sound source.
Channel MeetingNewResponseDataRecordingConfigAudioConfigChannel `json:"channel"`
// Codec using which the recording will be encoded. If VP8/VP9 is selected for
// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
// audioConfig is automatically set to vorbis.
Codec MeetingNewResponseDataRecordingConfigAudioConfigCodec `json:"codec"`
// Controls whether to export audio file seperately
ExportFile bool `json:"export_file"`
JSON meetingNewResponseDataRecordingConfigAudioConfigJSON `json:"-"`
}
Object containing configuration regarding the audio that is being recorded.
func (*MeetingNewResponseDataRecordingConfigAudioConfig) UnmarshalJSON ¶
func (r *MeetingNewResponseDataRecordingConfigAudioConfig) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataRecordingConfigAudioConfigChannel ¶
type MeetingNewResponseDataRecordingConfigAudioConfigChannel string
Audio signal pathway within an audio file that carries a specific sound source.
const ( MeetingNewResponseDataRecordingConfigAudioConfigChannelMono MeetingNewResponseDataRecordingConfigAudioConfigChannel = "mono" MeetingNewResponseDataRecordingConfigAudioConfigChannelStereo MeetingNewResponseDataRecordingConfigAudioConfigChannel = "stereo" )
func (MeetingNewResponseDataRecordingConfigAudioConfigChannel) IsKnown ¶
func (r MeetingNewResponseDataRecordingConfigAudioConfigChannel) IsKnown() bool
type MeetingNewResponseDataRecordingConfigAudioConfigCodec ¶
type MeetingNewResponseDataRecordingConfigAudioConfigCodec string
Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.
const ( MeetingNewResponseDataRecordingConfigAudioConfigCodecMP3 MeetingNewResponseDataRecordingConfigAudioConfigCodec = "MP3" MeetingNewResponseDataRecordingConfigAudioConfigCodecAac MeetingNewResponseDataRecordingConfigAudioConfigCodec = "AAC" )
func (MeetingNewResponseDataRecordingConfigAudioConfigCodec) IsKnown ¶
func (r MeetingNewResponseDataRecordingConfigAudioConfigCodec) IsKnown() bool
type MeetingNewResponseDataRecordingConfigLiveStreamingConfig ¶
type MeetingNewResponseDataRecordingConfigLiveStreamingConfig struct {
// RTMP URL to stream to
RtmpURL string `json:"rtmp_url" format:"uri"`
JSON meetingNewResponseDataRecordingConfigLiveStreamingConfigJSON `json:"-"`
}
func (*MeetingNewResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON ¶
func (r *MeetingNewResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataRecordingConfigRealtimekitBucketConfig ¶
type MeetingNewResponseDataRecordingConfigRealtimekitBucketConfig struct {
// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
// generated for a recording.
Enabled bool `json:"enabled" api:"required"`
JSON meetingNewResponseDataRecordingConfigRealtimekitBucketConfigJSON `json:"-"`
}
func (*MeetingNewResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON ¶
func (r *MeetingNewResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataRecordingConfigStorageConfig ¶
type MeetingNewResponseDataRecordingConfigStorageConfig struct {
// Type of storage media.
Type MeetingNewResponseDataRecordingConfigStorageConfigType `json:"type" api:"required"`
// Authentication method used for "sftp" type storage medium
AuthMethod MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket string `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host string `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password string `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path string `json:"path"`
// SSH destination server port for SFTP type storage medium
Port float64 `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey string `json:"private_key"`
// Region of the storage medium.
Region string `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret string `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username string `json:"username"`
JSON meetingNewResponseDataRecordingConfigStorageConfigJSON `json:"-"`
}
func (*MeetingNewResponseDataRecordingConfigStorageConfig) UnmarshalJSON ¶
func (r *MeetingNewResponseDataRecordingConfigStorageConfig) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod ¶
type MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( MeetingNewResponseDataRecordingConfigStorageConfigAuthMethodKey MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod = "KEY" MeetingNewResponseDataRecordingConfigStorageConfigAuthMethodPassword MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod = "PASSWORD" )
func (MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown ¶
func (r MeetingNewResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown() bool
type MeetingNewResponseDataRecordingConfigStorageConfigType ¶
type MeetingNewResponseDataRecordingConfigStorageConfigType string
Type of storage media.
const ( MeetingNewResponseDataRecordingConfigStorageConfigTypeAws MeetingNewResponseDataRecordingConfigStorageConfigType = "aws" MeetingNewResponseDataRecordingConfigStorageConfigTypeAzure MeetingNewResponseDataRecordingConfigStorageConfigType = "azure" MeetingNewResponseDataRecordingConfigStorageConfigTypeDigitalocean MeetingNewResponseDataRecordingConfigStorageConfigType = "digitalocean" MeetingNewResponseDataRecordingConfigStorageConfigTypeGcs MeetingNewResponseDataRecordingConfigStorageConfigType = "gcs" MeetingNewResponseDataRecordingConfigStorageConfigTypeSftp MeetingNewResponseDataRecordingConfigStorageConfigType = "sftp" )
func (MeetingNewResponseDataRecordingConfigStorageConfigType) IsKnown ¶
func (r MeetingNewResponseDataRecordingConfigStorageConfigType) IsKnown() bool
type MeetingNewResponseDataRecordingConfigVideoConfig ¶
type MeetingNewResponseDataRecordingConfigVideoConfig struct {
// Codec using which the recording will be encoded.
Codec MeetingNewResponseDataRecordingConfigVideoConfigCodec `json:"codec"`
// Controls whether to export video file seperately
ExportFile bool `json:"export_file"`
// Height of the recording video in pixels
Height int64 `json:"height"`
// Watermark to be added to the recording
Watermark MeetingNewResponseDataRecordingConfigVideoConfigWatermark `json:"watermark"`
// Width of the recording video in pixels
Width int64 `json:"width"`
JSON meetingNewResponseDataRecordingConfigVideoConfigJSON `json:"-"`
}
func (*MeetingNewResponseDataRecordingConfigVideoConfig) UnmarshalJSON ¶
func (r *MeetingNewResponseDataRecordingConfigVideoConfig) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataRecordingConfigVideoConfigCodec ¶
type MeetingNewResponseDataRecordingConfigVideoConfigCodec string
Codec using which the recording will be encoded.
const ( MeetingNewResponseDataRecordingConfigVideoConfigCodecH264 MeetingNewResponseDataRecordingConfigVideoConfigCodec = "H264" MeetingNewResponseDataRecordingConfigVideoConfigCodecVp8 MeetingNewResponseDataRecordingConfigVideoConfigCodec = "VP8" )
func (MeetingNewResponseDataRecordingConfigVideoConfigCodec) IsKnown ¶
func (r MeetingNewResponseDataRecordingConfigVideoConfigCodec) IsKnown() bool
type MeetingNewResponseDataRecordingConfigVideoConfigWatermark ¶
type MeetingNewResponseDataRecordingConfigVideoConfigWatermark struct {
// Position of the watermark
Position MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition `json:"position"`
// Size of the watermark
Size MeetingNewResponseDataRecordingConfigVideoConfigWatermarkSize `json:"size"`
// URL of the watermark image
URL string `json:"url" format:"uri"`
JSON meetingNewResponseDataRecordingConfigVideoConfigWatermarkJSON `json:"-"`
}
Watermark to be added to the recording
func (*MeetingNewResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON ¶
func (r *MeetingNewResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition ¶
type MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition string
Position of the watermark
const ( MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPositionLeftTop MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition = "left top" MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPositionRightTop MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition = "right top" MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPositionLeftBottom MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition = "left bottom" MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition = "right bottom" )
func (MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition) IsKnown ¶
func (r MeetingNewResponseDataRecordingConfigVideoConfigWatermarkPosition) IsKnown() bool
type MeetingNewResponseDataRecordingConfigVideoConfigWatermarkSize ¶
type MeetingNewResponseDataRecordingConfigVideoConfigWatermarkSize struct {
// Height of the watermark in px
Height int64 `json:"height"`
// Width of the watermark in px
Width int64 `json:"width"`
JSON meetingNewResponseDataRecordingConfigVideoConfigWatermarkSizeJSON `json:"-"`
}
Size of the watermark
func (*MeetingNewResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON ¶
func (r *MeetingNewResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON(data []byte) (err error)
type MeetingNewResponseDataStatus ¶
type MeetingNewResponseDataStatus string
Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.
const ( MeetingNewResponseDataStatusActive MeetingNewResponseDataStatus = "ACTIVE" MeetingNewResponseDataStatusInactive MeetingNewResponseDataStatus = "INACTIVE" )
func (MeetingNewResponseDataStatus) IsKnown ¶
func (r MeetingNewResponseDataStatus) IsKnown() bool
type MeetingRefreshParticipantTokenResponse ¶
type MeetingRefreshParticipantTokenResponse struct {
// Data returned by the operation
Data MeetingRefreshParticipantTokenResponseData `json:"data" api:"required"`
// Success status of the operation
Success bool `json:"success" api:"required"`
JSON meetingRefreshParticipantTokenResponseJSON `json:"-"`
}
func (*MeetingRefreshParticipantTokenResponse) UnmarshalJSON ¶
func (r *MeetingRefreshParticipantTokenResponse) UnmarshalJSON(data []byte) (err error)
type MeetingRefreshParticipantTokenResponseData ¶
type MeetingRefreshParticipantTokenResponseData struct {
// Regenerated participant's authentication token.
Token string `json:"token" api:"required"`
JSON meetingRefreshParticipantTokenResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*MeetingRefreshParticipantTokenResponseData) UnmarshalJSON ¶
func (r *MeetingRefreshParticipantTokenResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDParams ¶
type MeetingReplaceMeetingByIDParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// The AI Config allows you to customize the behavior of meeting transcriptions and
// summaries
AIConfig param.Field[MeetingReplaceMeetingByIDParamsAIConfig] `json:"ai_config"`
// Specifies if the meeting should start getting livestreamed on start.
LiveStreamOnStart param.Field[bool] `json:"live_stream_on_start"`
// If a meeting is set to persist_chat, meeting chat would remain for a week within
// the meeting space.
PersistChat param.Field[bool] `json:"persist_chat"`
// Specifies if the meeting should start getting recorded as soon as someone joins
// the meeting.
RecordOnStart param.Field[bool] `json:"record_on_start"`
// Recording Configurations to be used for this meeting. This level of configs
// takes higher preference over App level configs on the RealtimeKit developer
// portal.
RecordingConfig param.Field[MeetingReplaceMeetingByIDParamsRecordingConfig] `json:"recording_config"`
// Time in seconds, for which a session remains active, after the last participant
// has left the meeting.
SessionKeepAliveTimeInSecs param.Field[float64] `json:"session_keep_alive_time_in_secs"`
// Automatically generate summary of meetings using transcripts. Requires
// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
SummarizeOnEnd param.Field[bool] `json:"summarize_on_end"`
// Title of the meeting
Title param.Field[string] `json:"title"`
}
func (MeetingReplaceMeetingByIDParams) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParams) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsAIConfig ¶
type MeetingReplaceMeetingByIDParamsAIConfig struct {
// Summary Config
Summarization param.Field[MeetingReplaceMeetingByIDParamsAIConfigSummarization] `json:"summarization"`
// Transcription Configurations
Transcription param.Field[MeetingReplaceMeetingByIDParamsAIConfigTranscription] `json:"transcription"`
}
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
func (MeetingReplaceMeetingByIDParamsAIConfig) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsAIConfig) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsAIConfigSummarization ¶
type MeetingReplaceMeetingByIDParamsAIConfigSummarization struct {
// Defines the style of the summary, such as general, team meeting, or sales call.
SummaryType param.Field[MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType] `json:"summary_type"`
// Determines the text format of the summary, such as plain text or markdown.
TextFormat param.Field[MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat] `json:"text_format"`
// Sets the maximum number of words in the meeting summary.
WordLimit param.Field[int64] `json:"word_limit"`
}
Summary Config
func (MeetingReplaceMeetingByIDParamsAIConfigSummarization) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsAIConfigSummarization) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType ¶
type MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType string
Defines the style of the summary, such as general, team meeting, or sales call.
const ( MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeGeneral MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "general" MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeTeamMeeting MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "team_meeting" MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeSalesCall MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "sales_call" MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeClientCheckIn MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "client_check_in" MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeInterview MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "interview" MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeDailyStandup MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "daily_standup" MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "one_on_one_meeting" MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeLecture MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "lecture" MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryTypeCodeReview MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType = "code_review" )
func (MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType) IsKnown ¶
func (r MeetingReplaceMeetingByIDParamsAIConfigSummarizationSummaryType) IsKnown() bool
type MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat ¶
type MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat string
Determines the text format of the summary, such as plain text or markdown.
const ( MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormatPlainText MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat = "plain_text" MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormatMarkdown MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat = "markdown" )
func (MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat) IsKnown ¶
func (r MeetingReplaceMeetingByIDParamsAIConfigSummarizationTextFormat) IsKnown() bool
type MeetingReplaceMeetingByIDParamsAIConfigTranscription ¶
type MeetingReplaceMeetingByIDParamsAIConfigTranscription struct {
// Adds specific terms to improve accurate detection during transcription.
Keywords param.Field[[]string] `json:"keywords"`
// Specifies the language code for transcription to ensure accurate results.
Language param.Field[MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage] `json:"language"`
// Control the inclusion of offensive language in transcriptions.
ProfanityFilter param.Field[bool] `json:"profanity_filter"`
}
Transcription Configurations
func (MeetingReplaceMeetingByIDParamsAIConfigTranscription) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsAIConfigTranscription) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage ¶
type MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage string
Specifies the language code for transcription to ensure accurate results.
const ( MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageEnUs MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "en-US" MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageEnIn MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "en-IN" MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageDe MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "de" MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageHi MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "hi" MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageSv MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "sv" MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageRu MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "ru" MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguagePl MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "pl" MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageEl MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "el" MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageFr MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "fr" MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguageNl MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage = "nl" )
func (MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage) IsKnown ¶
func (r MeetingReplaceMeetingByIDParamsAIConfigTranscriptionLanguage) IsKnown() bool
type MeetingReplaceMeetingByIDParamsRecordingConfig ¶
type MeetingReplaceMeetingByIDParamsRecordingConfig struct {
// Object containing configuration regarding the audio that is being recorded.
AudioConfig param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfig] `json:"audio_config"`
// Adds a prefix to the beginning of the file name of the recording.
FileNamePrefix param.Field[string] `json:"file_name_prefix"`
LiveStreamingConfig param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigLiveStreamingConfig] `json:"live_streaming_config"`
// Specifies the maximum duration for recording in seconds, ranging from a minimum
// of 60 seconds to a maximum of 24 hours.
MaxSeconds param.Field[float64] `json:"max_seconds"`
RealtimekitBucketConfig param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigRealtimekitBucketConfig] `json:"realtimekit_bucket_config"`
StorageConfig param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfig] `json:"storage_config"`
VideoConfig param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfig] `json:"video_config"`
}
Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
func (MeetingReplaceMeetingByIDParamsRecordingConfig) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfig) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfig ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfig struct {
// Audio signal pathway within an audio file that carries a specific sound source.
Channel param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel] `json:"channel"`
// Codec using which the recording will be encoded. If VP8/VP9 is selected for
// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
// audioConfig is automatically set to vorbis.
Codec param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec] `json:"codec"`
// Controls whether to export audio file seperately
ExportFile param.Field[bool] `json:"export_file"`
}
Object containing configuration regarding the audio that is being recorded.
func (MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfig) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfig) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel string
Audio signal pathway within an audio file that carries a specific sound source.
const ( MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannelMono MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel = "mono" MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannelStereo MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel = "stereo" )
func (MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel) IsKnown ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigChannel) IsKnown() bool
type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec string
Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.
const ( MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodecMP3 MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec = "MP3" MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodecAac MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec = "AAC" )
func (MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec) IsKnown ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigAudioConfigCodec) IsKnown() bool
type MeetingReplaceMeetingByIDParamsRecordingConfigLiveStreamingConfig ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigLiveStreamingConfig struct {
// RTMP URL to stream to
RtmpURL param.Field[string] `json:"rtmp_url" format:"uri"`
}
func (MeetingReplaceMeetingByIDParamsRecordingConfigLiveStreamingConfig) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigLiveStreamingConfig) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsRecordingConfigRealtimekitBucketConfig ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigRealtimekitBucketConfig struct {
// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
// generated for a recording.
Enabled param.Field[bool] `json:"enabled" api:"required"`
}
func (MeetingReplaceMeetingByIDParamsRecordingConfigRealtimekitBucketConfig) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigRealtimekitBucketConfig) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfig ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfig struct {
// Type of storage media.
Type param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType] `json:"type" api:"required"`
// Access key of the storage medium. Access key is not required for the `gcs`
// storage media type.
//
// Note that this field is not readable by clients, only writeable.
AccessKey param.Field[string] `json:"access_key"`
// Authentication method used for "sftp" type storage medium
AuthMethod param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod] `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket param.Field[string] `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host param.Field[string] `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password param.Field[string] `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path param.Field[string] `json:"path"`
// SSH destination server port for SFTP type storage medium
Port param.Field[float64] `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey param.Field[string] `json:"private_key"`
// Region of the storage medium.
Region param.Field[string] `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret param.Field[string] `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username param.Field[string] `json:"username"`
}
func (MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfig) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfig) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethodKey MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod = "KEY" MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethodPassword MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod = "PASSWORD" )
func (MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod) IsKnown ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigAuthMethod) IsKnown() bool
type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType string
Type of storage media.
const ( MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigTypeAws MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType = "aws" MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigTypeAzure MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType = "azure" MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigTypeDigitalocean MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType = "digitalocean" MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigTypeGcs MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType = "gcs" MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigTypeSftp MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType = "sftp" )
func (MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType) IsKnown ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigStorageConfigType) IsKnown() bool
type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfig ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfig struct {
// Codec using which the recording will be encoded.
Codec param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec] `json:"codec"`
// Controls whether to export video file seperately
ExportFile param.Field[bool] `json:"export_file"`
// Height of the recording video in pixels
Height param.Field[int64] `json:"height"`
// Watermark to be added to the recording
Watermark param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermark] `json:"watermark"`
// Width of the recording video in pixels
Width param.Field[int64] `json:"width"`
}
func (MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfig) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfig) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec string
Codec using which the recording will be encoded.
const ( MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodecH264 MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec = "H264" MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodecVp8 MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec = "VP8" )
func (MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec) IsKnown ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigCodec) IsKnown() bool
type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermark ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermark struct {
// Position of the watermark
Position param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition] `json:"position"`
// Size of the watermark
Size param.Field[MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkSize] `json:"size"`
// URL of the watermark image
URL param.Field[string] `json:"url" format:"uri"`
}
Watermark to be added to the recording
func (MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermark) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermark) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition string
Position of the watermark
const ( MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPositionLeftTop MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition = "left top" MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPositionRightTop MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition = "right top" MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPositionLeftBottom MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition = "left bottom" MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition = "right bottom" )
func (MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition) IsKnown ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkPosition) IsKnown() bool
type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkSize ¶
type MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkSize struct {
// Height of the watermark in px
Height param.Field[int64] `json:"height"`
// Width of the watermark in px
Width param.Field[int64] `json:"width"`
}
Size of the watermark
func (MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkSize) MarshalJSON ¶
func (r MeetingReplaceMeetingByIDParamsRecordingConfigVideoConfigWatermarkSize) MarshalJSON() (data []byte, err error)
type MeetingReplaceMeetingByIDResponse ¶
type MeetingReplaceMeetingByIDResponse struct {
// Success status of the operation
Success bool `json:"success" api:"required"`
// Data returned by the operation
Data MeetingReplaceMeetingByIDResponseData `json:"data"`
JSON meetingReplaceMeetingByIDResponseJSON `json:"-"`
}
func (*MeetingReplaceMeetingByIDResponse) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponse) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseData ¶
type MeetingReplaceMeetingByIDResponseData struct {
// ID of the meeting.
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// The AI Config allows you to customize the behavior of meeting transcriptions and
// summaries
AIConfig MeetingReplaceMeetingByIDResponseDataAIConfig `json:"ai_config"`
// Specifies if the meeting should start getting livestreamed on start.
LiveStreamOnStart bool `json:"live_stream_on_start"`
// Specifies if Chat within a meeting should persist for a week.
PersistChat bool `json:"persist_chat"`
// Specifies if the meeting should start getting recorded as soon as someone joins
// the meeting.
RecordOnStart bool `json:"record_on_start"`
// Recording Configurations to be used for this meeting. This level of configs
// takes higher preference over App level configs on the RealtimeKit developer
// portal.
RecordingConfig MeetingReplaceMeetingByIDResponseDataRecordingConfig `json:"recording_config"`
// Time in seconds, for which a session remains active, after the last participant
// has left the meeting.
SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
// `INACTIVE` meeting.
Status MeetingReplaceMeetingByIDResponseDataStatus `json:"status"`
// Automatically generate summary of meetings using transcripts. Requires
// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
SummarizeOnEnd bool `json:"summarize_on_end"`
// Title of the meeting.
Title string `json:"title"`
JSON meetingReplaceMeetingByIDResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*MeetingReplaceMeetingByIDResponseData) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataAIConfig ¶
type MeetingReplaceMeetingByIDResponseDataAIConfig struct {
// Summary Config
Summarization MeetingReplaceMeetingByIDResponseDataAIConfigSummarization `json:"summarization"`
// Transcription Configurations
Transcription MeetingReplaceMeetingByIDResponseDataAIConfigTranscription `json:"transcription"`
JSON meetingReplaceMeetingByIDResponseDataAIConfigJSON `json:"-"`
}
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
func (*MeetingReplaceMeetingByIDResponseDataAIConfig) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataAIConfig) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataAIConfigSummarization ¶
type MeetingReplaceMeetingByIDResponseDataAIConfigSummarization struct {
// Defines the style of the summary, such as general, team meeting, or sales call.
SummaryType MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType `json:"summary_type"`
// Determines the text format of the summary, such as plain text or markdown.
TextFormat MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat `json:"text_format"`
// Sets the maximum number of words in the meeting summary.
WordLimit int64 `json:"word_limit"`
JSON meetingReplaceMeetingByIDResponseDataAIConfigSummarizationJSON `json:"-"`
}
Summary Config
func (*MeetingReplaceMeetingByIDResponseDataAIConfigSummarization) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataAIConfigSummarization) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType ¶
type MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType string
Defines the style of the summary, such as general, team meeting, or sales call.
const ( MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeGeneral MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "general" MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeTeamMeeting MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "team_meeting" MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeSalesCall MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "sales_call" MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeClientCheckIn MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "client_check_in" MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeInterview MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "interview" MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeDailyStandup MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "daily_standup" MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "one_on_one_meeting" MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeLecture MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "lecture" MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryTypeCodeReview MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType = "code_review" )
func (MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType) IsKnown ¶
func (r MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationSummaryType) IsKnown() bool
type MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat ¶
type MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat string
Determines the text format of the summary, such as plain text or markdown.
const ( MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormatPlainText MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat = "plain_text" MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormatMarkdown MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat = "markdown" )
func (MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat) IsKnown ¶
func (r MeetingReplaceMeetingByIDResponseDataAIConfigSummarizationTextFormat) IsKnown() bool
type MeetingReplaceMeetingByIDResponseDataAIConfigTranscription ¶
type MeetingReplaceMeetingByIDResponseDataAIConfigTranscription struct {
// Adds specific terms to improve accurate detection during transcription.
Keywords []string `json:"keywords"`
// Specifies the language code for transcription to ensure accurate results.
Language MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage `json:"language"`
// Control the inclusion of offensive language in transcriptions.
ProfanityFilter bool `json:"profanity_filter"`
JSON meetingReplaceMeetingByIDResponseDataAIConfigTranscriptionJSON `json:"-"`
}
Transcription Configurations
func (*MeetingReplaceMeetingByIDResponseDataAIConfigTranscription) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataAIConfigTranscription) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage ¶
type MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage string
Specifies the language code for transcription to ensure accurate results.
const ( MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageEnUs MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-US" MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageEnIn MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-IN" MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageDe MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "de" MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageHi MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "hi" MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageSv MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "sv" MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageRu MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "ru" MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguagePl MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "pl" MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageEl MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "el" MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageFr MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "fr" MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguageNl MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage = "nl" )
func (MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage) IsKnown ¶
func (r MeetingReplaceMeetingByIDResponseDataAIConfigTranscriptionLanguage) IsKnown() bool
type MeetingReplaceMeetingByIDResponseDataRecordingConfig ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfig struct {
// Object containing configuration regarding the audio that is being recorded.
AudioConfig MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfig `json:"audio_config"`
// Adds a prefix to the beginning of the file name of the recording.
FileNamePrefix string `json:"file_name_prefix"`
LiveStreamingConfig MeetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfig `json:"live_streaming_config"`
// Specifies the maximum duration for recording in seconds, ranging from a minimum
// of 60 seconds to a maximum of 24 hours.
MaxSeconds float64 `json:"max_seconds"`
RealtimekitBucketConfig MeetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig `json:"realtimekit_bucket_config"`
StorageConfig MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfig `json:"storage_config" api:"nullable"`
VideoConfig MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfig `json:"video_config"`
JSON meetingReplaceMeetingByIDResponseDataRecordingConfigJSON `json:"-"`
}
Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
func (*MeetingReplaceMeetingByIDResponseDataRecordingConfig) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataRecordingConfig) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfig ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfig struct {
// Audio signal pathway within an audio file that carries a specific sound source.
Channel MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel `json:"channel"`
// Codec using which the recording will be encoded. If VP8/VP9 is selected for
// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
// audioConfig is automatically set to vorbis.
Codec MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec `json:"codec"`
// Controls whether to export audio file seperately
ExportFile bool `json:"export_file"`
JSON meetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigJSON `json:"-"`
}
Object containing configuration regarding the audio that is being recorded.
func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfig) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfig) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel string
Audio signal pathway within an audio file that carries a specific sound source.
const ( MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannelMono MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "mono" MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannelStereo MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "stereo" )
func (MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel) IsKnown ¶
func (r MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigChannel) IsKnown() bool
type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec string
Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.
const ( MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodecMP3 MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "MP3" MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodecAac MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "AAC" )
func (MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec) IsKnown ¶
func (r MeetingReplaceMeetingByIDResponseDataRecordingConfigAudioConfigCodec) IsKnown() bool
type MeetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfig ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfig struct {
// RTMP URL to stream to
RtmpURL string `json:"rtmp_url" format:"uri"`
JSON meetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfigJSON `json:"-"`
}
func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig struct {
// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
// generated for a recording.
Enabled bool `json:"enabled" api:"required"`
JSON meetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfigJSON `json:"-"`
}
func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfig ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfig struct {
// Type of storage media.
Type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType `json:"type" api:"required"`
// Authentication method used for "sftp" type storage medium
AuthMethod MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket string `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host string `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password string `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path string `json:"path"`
// SSH destination server port for SFTP type storage medium
Port float64 `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey string `json:"private_key"`
// Region of the storage medium.
Region string `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret string `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username string `json:"username"`
JSON meetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigJSON `json:"-"`
}
func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfig) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfig) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodKey MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "KEY" MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodPassword MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "PASSWORD" )
func (MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown ¶
func (r MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown() bool
type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType string
Type of storage media.
const ( MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigTypeAws MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType = "aws" MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigTypeAzure MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType = "azure" MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigTypeDigitalocean MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType = "digitalocean" MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigTypeGcs MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType = "gcs" MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigTypeSftp MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType = "sftp" )
func (MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType) IsKnown ¶
func (r MeetingReplaceMeetingByIDResponseDataRecordingConfigStorageConfigType) IsKnown() bool
type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfig ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfig struct {
// Codec using which the recording will be encoded.
Codec MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec `json:"codec"`
// Controls whether to export video file seperately
ExportFile bool `json:"export_file"`
// Height of the recording video in pixels
Height int64 `json:"height"`
// Watermark to be added to the recording
Watermark MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermark `json:"watermark"`
// Width of the recording video in pixels
Width int64 `json:"width"`
JSON meetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigJSON `json:"-"`
}
func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfig) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfig) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec string
Codec using which the recording will be encoded.
const ( MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodecH264 MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "H264" MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodecVp8 MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "VP8" )
func (MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec) IsKnown ¶
func (r MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigCodec) IsKnown() bool
type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermark ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermark struct {
// Position of the watermark
Position MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition `json:"position"`
// Size of the watermark
Size MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize `json:"size"`
// URL of the watermark image
URL string `json:"url" format:"uri"`
JSON meetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkJSON `json:"-"`
}
Watermark to be added to the recording
func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition string
Position of the watermark
const ( MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftTop MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left top" MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightTop MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right top" MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftBottom MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left bottom" MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right bottom" )
type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize ¶
type MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize struct {
// Height of the watermark in px
Height int64 `json:"height"`
// Width of the watermark in px
Width int64 `json:"width"`
JSON meetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSizeJSON `json:"-"`
}
Size of the watermark
func (*MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON ¶
func (r *MeetingReplaceMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON(data []byte) (err error)
type MeetingReplaceMeetingByIDResponseDataStatus ¶
type MeetingReplaceMeetingByIDResponseDataStatus string
Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.
const ( MeetingReplaceMeetingByIDResponseDataStatusActive MeetingReplaceMeetingByIDResponseDataStatus = "ACTIVE" MeetingReplaceMeetingByIDResponseDataStatusInactive MeetingReplaceMeetingByIDResponseDataStatus = "INACTIVE" )
func (MeetingReplaceMeetingByIDResponseDataStatus) IsKnown ¶
func (r MeetingReplaceMeetingByIDResponseDataStatus) IsKnown() bool
type MeetingService ¶
type MeetingService struct {
Options []option.RequestOption
}
MeetingService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewMeetingService method instead.
func NewMeetingService ¶
func NewMeetingService(opts ...option.RequestOption) (r *MeetingService)
NewMeetingService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*MeetingService) AddParticipant ¶
func (r *MeetingService) AddParticipant(ctx context.Context, appID string, meetingID string, params MeetingAddParticipantParams, opts ...option.RequestOption) (res *MeetingAddParticipantResponse, err error)
Adds a participant to the given meeting ID.
func (*MeetingService) DeleteMeetingParticipant ¶
func (r *MeetingService) DeleteMeetingParticipant(ctx context.Context, appID string, meetingID string, participantID string, body MeetingDeleteMeetingParticipantParams, opts ...option.RequestOption) (res *MeetingDeleteMeetingParticipantResponse, err error)
Deletes a participant for the given meeting and participant ID.
func (*MeetingService) EditParticipant ¶
func (r *MeetingService) EditParticipant(ctx context.Context, appID string, meetingID string, participantID string, params MeetingEditParticipantParams, opts ...option.RequestOption) (res *MeetingEditParticipantResponse, err error)
Updates a participant's details for the given meeting and participant ID.
func (*MeetingService) Get ¶
func (r *MeetingService) Get(ctx context.Context, appID string, params MeetingGetParams, opts ...option.RequestOption) (res *MeetingGetResponse, err error)
Returns all meetings for the given App ID.
func (*MeetingService) GetMeetingByID ¶
func (r *MeetingService) GetMeetingByID(ctx context.Context, appID string, meetingID string, params MeetingGetMeetingByIDParams, opts ...option.RequestOption) (res *MeetingGetMeetingByIDResponse, err error)
Returns a meeting details in an App for the given meeting ID.
func (*MeetingService) GetMeetingParticipant ¶
func (r *MeetingService) GetMeetingParticipant(ctx context.Context, appID string, meetingID string, participantID string, query MeetingGetMeetingParticipantParams, opts ...option.RequestOption) (res *MeetingGetMeetingParticipantResponse, err error)
Returns a participant details for the given meeting and participant ID.
func (*MeetingService) GetMeetingParticipants ¶
func (r *MeetingService) GetMeetingParticipants(ctx context.Context, appID string, meetingID string, params MeetingGetMeetingParticipantsParams, opts ...option.RequestOption) (res *MeetingGetMeetingParticipantsResponse, err error)
Returns all participants detail for the given meeting ID.
func (*MeetingService) New ¶
func (r *MeetingService) New(ctx context.Context, appID string, params MeetingNewParams, opts ...option.RequestOption) (res *MeetingNewResponse, err error)
Create a meeting for the given App ID.
func (*MeetingService) RefreshParticipantToken ¶
func (r *MeetingService) RefreshParticipantToken(ctx context.Context, appID string, meetingID string, participantID string, body MeetingRefreshParticipantTokenParams, opts ...option.RequestOption) (res *MeetingRefreshParticipantTokenResponse, err error)
Regenerates participant's authentication token for the given meeting and participant ID.
func (*MeetingService) ReplaceMeetingByID ¶
func (r *MeetingService) ReplaceMeetingByID(ctx context.Context, appID string, meetingID string, params MeetingReplaceMeetingByIDParams, opts ...option.RequestOption) (res *MeetingReplaceMeetingByIDResponse, err error)
Replaces all the details for the given meeting ID.
func (*MeetingService) UpdateMeetingByID ¶
func (r *MeetingService) UpdateMeetingByID(ctx context.Context, appID string, meetingID string, params MeetingUpdateMeetingByIDParams, opts ...option.RequestOption) (res *MeetingUpdateMeetingByIDResponse, err error)
Updates a meeting in an App for the given meeting ID.
type MeetingUpdateMeetingByIDParams ¶
type MeetingUpdateMeetingByIDParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// The AI Config allows you to customize the behavior of meeting transcriptions and
// summaries
AIConfig param.Field[MeetingUpdateMeetingByIDParamsAIConfig] `json:"ai_config"`
// Specifies if the meeting should start getting livestreamed on start.
LiveStreamOnStart param.Field[bool] `json:"live_stream_on_start"`
// If a meeting is updated to persist_chat, meeting chat would remain for a week
// within the meeting space.
PersistChat param.Field[bool] `json:"persist_chat"`
// Specifies if the meeting should start getting recorded as soon as someone joins
// the meeting.
RecordOnStart param.Field[bool] `json:"record_on_start"`
// Time in seconds, for which a session remains active, after the last participant
// has left the meeting.
SessionKeepAliveTimeInSecs param.Field[float64] `json:"session_keep_alive_time_in_secs"`
// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
// `INACTIVE` meeting.
Status param.Field[MeetingUpdateMeetingByIDParamsStatus] `json:"status"`
// Automatically generate summary of meetings using transcripts. Requires
// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
SummarizeOnEnd param.Field[bool] `json:"summarize_on_end"`
// Title of the meeting
Title param.Field[string] `json:"title"`
}
func (MeetingUpdateMeetingByIDParams) MarshalJSON ¶
func (r MeetingUpdateMeetingByIDParams) MarshalJSON() (data []byte, err error)
type MeetingUpdateMeetingByIDParamsAIConfig ¶
type MeetingUpdateMeetingByIDParamsAIConfig struct {
// Summary Config
Summarization param.Field[MeetingUpdateMeetingByIDParamsAIConfigSummarization] `json:"summarization"`
// Transcription Configurations
Transcription param.Field[MeetingUpdateMeetingByIDParamsAIConfigTranscription] `json:"transcription"`
}
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
func (MeetingUpdateMeetingByIDParamsAIConfig) MarshalJSON ¶
func (r MeetingUpdateMeetingByIDParamsAIConfig) MarshalJSON() (data []byte, err error)
type MeetingUpdateMeetingByIDParamsAIConfigSummarization ¶
type MeetingUpdateMeetingByIDParamsAIConfigSummarization struct {
// Defines the style of the summary, such as general, team meeting, or sales call.
SummaryType param.Field[MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType] `json:"summary_type"`
// Determines the text format of the summary, such as plain text or markdown.
TextFormat param.Field[MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat] `json:"text_format"`
// Sets the maximum number of words in the meeting summary.
WordLimit param.Field[int64] `json:"word_limit"`
}
Summary Config
func (MeetingUpdateMeetingByIDParamsAIConfigSummarization) MarshalJSON ¶
func (r MeetingUpdateMeetingByIDParamsAIConfigSummarization) MarshalJSON() (data []byte, err error)
type MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType ¶
type MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType string
Defines the style of the summary, such as general, team meeting, or sales call.
const ( MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeGeneral MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "general" MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeTeamMeeting MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "team_meeting" MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeSalesCall MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "sales_call" MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeClientCheckIn MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "client_check_in" MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeInterview MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "interview" MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeDailyStandup MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "daily_standup" MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "one_on_one_meeting" MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeLecture MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "lecture" MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryTypeCodeReview MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType = "code_review" )
func (MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType) IsKnown ¶
func (r MeetingUpdateMeetingByIDParamsAIConfigSummarizationSummaryType) IsKnown() bool
type MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat ¶
type MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat string
Determines the text format of the summary, such as plain text or markdown.
const ( MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormatPlainText MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat = "plain_text" MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormatMarkdown MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat = "markdown" )
func (MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat) IsKnown ¶
func (r MeetingUpdateMeetingByIDParamsAIConfigSummarizationTextFormat) IsKnown() bool
type MeetingUpdateMeetingByIDParamsAIConfigTranscription ¶
type MeetingUpdateMeetingByIDParamsAIConfigTranscription struct {
// Adds specific terms to improve accurate detection during transcription.
Keywords param.Field[[]string] `json:"keywords"`
// Specifies the language code for transcription to ensure accurate results.
Language param.Field[MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage] `json:"language"`
// Control the inclusion of offensive language in transcriptions.
ProfanityFilter param.Field[bool] `json:"profanity_filter"`
}
Transcription Configurations
func (MeetingUpdateMeetingByIDParamsAIConfigTranscription) MarshalJSON ¶
func (r MeetingUpdateMeetingByIDParamsAIConfigTranscription) MarshalJSON() (data []byte, err error)
type MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage ¶
type MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage string
Specifies the language code for transcription to ensure accurate results.
const ( MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageEnUs MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "en-US" MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageEnIn MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "en-IN" MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageDe MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "de" MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageHi MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "hi" MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageSv MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "sv" MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageRu MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "ru" MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguagePl MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "pl" MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageEl MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "el" MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageFr MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "fr" MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguageNl MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage = "nl" )
func (MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage) IsKnown ¶
func (r MeetingUpdateMeetingByIDParamsAIConfigTranscriptionLanguage) IsKnown() bool
type MeetingUpdateMeetingByIDParamsStatus ¶
type MeetingUpdateMeetingByIDParamsStatus string
Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.
const ( MeetingUpdateMeetingByIDParamsStatusActive MeetingUpdateMeetingByIDParamsStatus = "ACTIVE" MeetingUpdateMeetingByIDParamsStatusInactive MeetingUpdateMeetingByIDParamsStatus = "INACTIVE" )
func (MeetingUpdateMeetingByIDParamsStatus) IsKnown ¶
func (r MeetingUpdateMeetingByIDParamsStatus) IsKnown() bool
type MeetingUpdateMeetingByIDResponse ¶
type MeetingUpdateMeetingByIDResponse struct {
// Success status of the operation
Success bool `json:"success" api:"required"`
// Data returned by the operation
Data MeetingUpdateMeetingByIDResponseData `json:"data"`
JSON meetingUpdateMeetingByIDResponseJSON `json:"-"`
}
func (*MeetingUpdateMeetingByIDResponse) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponse) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseData ¶
type MeetingUpdateMeetingByIDResponseData struct {
// ID of the meeting.
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// The AI Config allows you to customize the behavior of meeting transcriptions and
// summaries
AIConfig MeetingUpdateMeetingByIDResponseDataAIConfig `json:"ai_config"`
// Specifies if the meeting should start getting livestreamed on start.
LiveStreamOnStart bool `json:"live_stream_on_start"`
// Specifies if Chat within a meeting should persist for a week.
PersistChat bool `json:"persist_chat"`
// Specifies if the meeting should start getting recorded as soon as someone joins
// the meeting.
RecordOnStart bool `json:"record_on_start"`
// Recording Configurations to be used for this meeting. This level of configs
// takes higher preference over App level configs on the RealtimeKit developer
// portal.
RecordingConfig MeetingUpdateMeetingByIDResponseDataRecordingConfig `json:"recording_config"`
// Time in seconds, for which a session remains active, after the last participant
// has left the meeting.
SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
// `INACTIVE` meeting.
Status MeetingUpdateMeetingByIDResponseDataStatus `json:"status"`
// Automatically generate summary of meetings using transcripts. Requires
// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
SummarizeOnEnd bool `json:"summarize_on_end"`
// Title of the meeting.
Title string `json:"title"`
JSON meetingUpdateMeetingByIDResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*MeetingUpdateMeetingByIDResponseData) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseData) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataAIConfig ¶
type MeetingUpdateMeetingByIDResponseDataAIConfig struct {
// Summary Config
Summarization MeetingUpdateMeetingByIDResponseDataAIConfigSummarization `json:"summarization"`
// Transcription Configurations
Transcription MeetingUpdateMeetingByIDResponseDataAIConfigTranscription `json:"transcription"`
JSON meetingUpdateMeetingByIDResponseDataAIConfigJSON `json:"-"`
}
The AI Config allows you to customize the behavior of meeting transcriptions and summaries
func (*MeetingUpdateMeetingByIDResponseDataAIConfig) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataAIConfig) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataAIConfigSummarization ¶
type MeetingUpdateMeetingByIDResponseDataAIConfigSummarization struct {
// Defines the style of the summary, such as general, team meeting, or sales call.
SummaryType MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType `json:"summary_type"`
// Determines the text format of the summary, such as plain text or markdown.
TextFormat MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat `json:"text_format"`
// Sets the maximum number of words in the meeting summary.
WordLimit int64 `json:"word_limit"`
JSON meetingUpdateMeetingByIDResponseDataAIConfigSummarizationJSON `json:"-"`
}
Summary Config
func (*MeetingUpdateMeetingByIDResponseDataAIConfigSummarization) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataAIConfigSummarization) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType ¶
type MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType string
Defines the style of the summary, such as general, team meeting, or sales call.
const ( MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeGeneral MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "general" MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeTeamMeeting MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "team_meeting" MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeSalesCall MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "sales_call" MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeClientCheckIn MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "client_check_in" MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeInterview MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "interview" MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeDailyStandup MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "daily_standup" MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeOneOnOneMeeting MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "one_on_one_meeting" MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeLecture MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "lecture" MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryTypeCodeReview MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType = "code_review" )
func (MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType) IsKnown ¶
func (r MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationSummaryType) IsKnown() bool
type MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat ¶
type MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat string
Determines the text format of the summary, such as plain text or markdown.
const ( MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormatPlainText MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat = "plain_text" MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormatMarkdown MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat = "markdown" )
func (MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat) IsKnown ¶
func (r MeetingUpdateMeetingByIDResponseDataAIConfigSummarizationTextFormat) IsKnown() bool
type MeetingUpdateMeetingByIDResponseDataAIConfigTranscription ¶
type MeetingUpdateMeetingByIDResponseDataAIConfigTranscription struct {
// Adds specific terms to improve accurate detection during transcription.
Keywords []string `json:"keywords"`
// Specifies the language code for transcription to ensure accurate results.
Language MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage `json:"language"`
// Control the inclusion of offensive language in transcriptions.
ProfanityFilter bool `json:"profanity_filter"`
JSON meetingUpdateMeetingByIDResponseDataAIConfigTranscriptionJSON `json:"-"`
}
Transcription Configurations
func (*MeetingUpdateMeetingByIDResponseDataAIConfigTranscription) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataAIConfigTranscription) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage ¶
type MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage string
Specifies the language code for transcription to ensure accurate results.
const ( MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageEnUs MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-US" MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageEnIn MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "en-IN" MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageDe MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "de" MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageHi MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "hi" MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageSv MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "sv" MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageRu MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "ru" MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguagePl MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "pl" MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageEl MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "el" MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageFr MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "fr" MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguageNl MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage = "nl" )
func (MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage) IsKnown ¶
func (r MeetingUpdateMeetingByIDResponseDataAIConfigTranscriptionLanguage) IsKnown() bool
type MeetingUpdateMeetingByIDResponseDataRecordingConfig ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfig struct {
// Object containing configuration regarding the audio that is being recorded.
AudioConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfig `json:"audio_config"`
// Adds a prefix to the beginning of the file name of the recording.
FileNamePrefix string `json:"file_name_prefix"`
LiveStreamingConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfig `json:"live_streaming_config"`
// Specifies the maximum duration for recording in seconds, ranging from a minimum
// of 60 seconds to a maximum of 24 hours.
MaxSeconds float64 `json:"max_seconds"`
RealtimekitBucketConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig `json:"realtimekit_bucket_config"`
StorageConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfig `json:"storage_config" api:"nullable"`
VideoConfig MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfig `json:"video_config"`
JSON meetingUpdateMeetingByIDResponseDataRecordingConfigJSON `json:"-"`
}
Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
func (*MeetingUpdateMeetingByIDResponseDataRecordingConfig) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataRecordingConfig) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfig ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfig struct {
// Audio signal pathway within an audio file that carries a specific sound source.
Channel MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel `json:"channel"`
// Codec using which the recording will be encoded. If VP8/VP9 is selected for
// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
// audioConfig is automatically set to vorbis.
Codec MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec `json:"codec"`
// Controls whether to export audio file seperately
ExportFile bool `json:"export_file"`
JSON meetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigJSON `json:"-"`
}
Object containing configuration regarding the audio that is being recorded.
func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfig) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfig) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel string
Audio signal pathway within an audio file that carries a specific sound source.
const ( MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannelMono MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "mono" MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannelStereo MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel = "stereo" )
func (MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel) IsKnown ¶
func (r MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigChannel) IsKnown() bool
type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec string
Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.
const ( MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodecMP3 MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "MP3" MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodecAac MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec = "AAC" )
func (MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec) IsKnown ¶
func (r MeetingUpdateMeetingByIDResponseDataRecordingConfigAudioConfigCodec) IsKnown() bool
type MeetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfig ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfig struct {
// RTMP URL to stream to
RtmpURL string `json:"rtmp_url" format:"uri"`
JSON meetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfigJSON `json:"-"`
}
func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataRecordingConfigLiveStreamingConfig) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig struct {
// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
// generated for a recording.
Enabled bool `json:"enabled" api:"required"`
JSON meetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfigJSON `json:"-"`
}
func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataRecordingConfigRealtimekitBucketConfig) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfig ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfig struct {
// Type of storage media.
Type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType `json:"type" api:"required"`
// Authentication method used for "sftp" type storage medium
AuthMethod MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket string `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host string `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password string `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path string `json:"path"`
// SSH destination server port for SFTP type storage medium
Port float64 `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey string `json:"private_key"`
// Region of the storage medium.
Region string `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret string `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username string `json:"username"`
JSON meetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigJSON `json:"-"`
}
func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfig) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfig) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodKey MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "KEY" MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethodPassword MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod = "PASSWORD" )
func (MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown ¶
func (r MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigAuthMethod) IsKnown() bool
type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType string
Type of storage media.
const ( MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigTypeAws MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType = "aws" MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigTypeAzure MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType = "azure" MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigTypeDigitalocean MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType = "digitalocean" MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigTypeGcs MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType = "gcs" MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigTypeSftp MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType = "sftp" )
func (MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType) IsKnown ¶
func (r MeetingUpdateMeetingByIDResponseDataRecordingConfigStorageConfigType) IsKnown() bool
type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfig ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfig struct {
// Codec using which the recording will be encoded.
Codec MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec `json:"codec"`
// Controls whether to export video file seperately
ExportFile bool `json:"export_file"`
// Height of the recording video in pixels
Height int64 `json:"height"`
// Watermark to be added to the recording
Watermark MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermark `json:"watermark"`
// Width of the recording video in pixels
Width int64 `json:"width"`
JSON meetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigJSON `json:"-"`
}
func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfig) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfig) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec string
Codec using which the recording will be encoded.
const ( MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodecH264 MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "H264" MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodecVp8 MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec = "VP8" )
func (MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec) IsKnown ¶
func (r MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigCodec) IsKnown() bool
type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermark ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermark struct {
// Position of the watermark
Position MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition `json:"position"`
// Size of the watermark
Size MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize `json:"size"`
// URL of the watermark image
URL string `json:"url" format:"uri"`
JSON meetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkJSON `json:"-"`
}
Watermark to be added to the recording
func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermark) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition string
Position of the watermark
const ( MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftTop MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left top" MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightTop MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right top" MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionLeftBottom MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "left bottom" MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPositionRightBottom MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkPosition = "right bottom" )
type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize ¶
type MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize struct {
// Height of the watermark in px
Height int64 `json:"height"`
// Width of the watermark in px
Width int64 `json:"width"`
JSON meetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSizeJSON `json:"-"`
}
Size of the watermark
func (*MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON ¶
func (r *MeetingUpdateMeetingByIDResponseDataRecordingConfigVideoConfigWatermarkSize) UnmarshalJSON(data []byte) (err error)
type MeetingUpdateMeetingByIDResponseDataStatus ¶
type MeetingUpdateMeetingByIDResponseDataStatus string
Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.
const ( MeetingUpdateMeetingByIDResponseDataStatusActive MeetingUpdateMeetingByIDResponseDataStatus = "ACTIVE" MeetingUpdateMeetingByIDResponseDataStatusInactive MeetingUpdateMeetingByIDResponseDataStatus = "INACTIVE" )
func (MeetingUpdateMeetingByIDResponseDataStatus) IsKnown ¶
func (r MeetingUpdateMeetingByIDResponseDataStatus) IsKnown() bool
type MemberPoliciesAccess ¶
type MemberPoliciesAccess = shared.MemberPoliciesAccess
Allow or deny operations against the resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroup ¶
type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroupsMeta ¶
type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type MemberPoliciesResourceGroup ¶
type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup
A group of scoped resources.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsMeta ¶
type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta
Attributes associated to the resource group.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScope ¶
type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope
A scope is a combination of scope objects which provides additional context.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScopeObject ¶
type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject
A scope object represents any resource that can have actions applied against invite.
This is an alias to an internal type.
type MemberStatus ¶
type MemberStatus = shared.MemberStatus
A member's status in the account.
This is an alias to an internal type.
type MemberUser ¶
type MemberUser = shared.MemberUser
Details of the user associated to the membership.
This is an alias to an internal type.
type PermissionGrant ¶
type PermissionGrant = shared.PermissionGrant
This is an alias to an internal type.
type PermissionGrantParam ¶
type PermissionGrantParam = shared.PermissionGrantParam
This is an alias to an internal type.
type PresetDeleteParams ¶
type PresetDeleteResponse ¶
type PresetDeleteResponse struct {
// Data returned by the operation
Data PresetDeleteResponseData `json:"data" api:"required"`
// Success status of the operation
Success bool `json:"success" api:"required"`
JSON presetDeleteResponseJSON `json:"-"`
}
func (*PresetDeleteResponse) UnmarshalJSON ¶
func (r *PresetDeleteResponse) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseData ¶
type PresetDeleteResponseData struct {
// ID of the preset
ID string `json:"id" api:"required" format:"uuid"`
Config PresetDeleteResponseDataConfig `json:"config" api:"required"`
// Name of the preset
Name string `json:"name" api:"required"`
UI PresetDeleteResponseDataUI `json:"ui" api:"required"`
Permissions PresetDeleteResponseDataPermissions `json:"permissions"`
JSON presetDeleteResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*PresetDeleteResponseData) UnmarshalJSON ¶
func (r *PresetDeleteResponseData) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataConfig ¶
type PresetDeleteResponseDataConfig struct {
MaxScreenshareCount int64 `json:"max_screenshare_count" api:"required"`
// Maximum number of streams that are visible on a device
MaxVideoStreams PresetDeleteResponseDataConfigMaxVideoStreams `json:"max_video_streams" api:"required"`
// Media configuration options. eg: Video quality
Media PresetDeleteResponseDataConfigMedia `json:"media" api:"required"`
// Type of the meeting
ViewType PresetDeleteResponseDataConfigViewType `json:"view_type" api:"required"`
JSON presetDeleteResponseDataConfigJSON `json:"-"`
}
func (*PresetDeleteResponseDataConfig) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataConfig) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataConfigMaxVideoStreams ¶
type PresetDeleteResponseDataConfigMaxVideoStreams struct {
// Maximum number of video streams visible on desktop devices
Desktop int64 `json:"desktop" api:"required"`
// Maximum number of streams visible on mobile devices
Mobile int64 `json:"mobile" api:"required"`
JSON presetDeleteResponseDataConfigMaxVideoStreamsJSON `json:"-"`
}
Maximum number of streams that are visible on a device
func (*PresetDeleteResponseDataConfigMaxVideoStreams) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataConfigMaxVideoStreams) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataConfigMedia ¶
type PresetDeleteResponseDataConfigMedia struct {
Screenshare PresetDeleteResponseDataConfigMediaScreenshare `json:"screenshare" api:"required"`
// Configuration options for participant videos
Video PresetDeleteResponseDataConfigMediaVideo `json:"video" api:"required"`
// Control options for Audio quality.
Audio PresetDeleteResponseDataConfigMediaAudio `json:"audio"`
JSON presetDeleteResponseDataConfigMediaJSON `json:"-"`
}
Media configuration options. eg: Video quality
func (*PresetDeleteResponseDataConfigMedia) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataConfigMedia) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataConfigMediaAudio ¶
type PresetDeleteResponseDataConfigMediaAudio struct {
// Enable High Quality Audio for your meetings
EnableHighBitrate bool `json:"enable_high_bitrate"`
// Enable Stereo for your meetings
EnableStereo bool `json:"enable_stereo"`
JSON presetDeleteResponseDataConfigMediaAudioJSON `json:"-"`
}
Control options for Audio quality.
func (*PresetDeleteResponseDataConfigMediaAudio) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataConfigMediaAudio) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataConfigMediaScreenshare ¶
type PresetDeleteResponseDataConfigMediaScreenshare struct {
FrameRate int64 `json:"frame_rate" api:"required"`
// Quality of screen share
}
Configuration options for participant screen shares
func (*PresetDeleteResponseDataConfigMediaScreenshare) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataConfigMediaScreenshare) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataConfigMediaScreenshareQuality ¶
type PresetDeleteResponseDataConfigMediaScreenshareQuality string
Quality of screen share
const ( )
func (PresetDeleteResponseDataConfigMediaScreenshareQuality) IsKnown ¶
func (r PresetDeleteResponseDataConfigMediaScreenshareQuality) IsKnown() bool
type PresetDeleteResponseDataConfigMediaVideo ¶
type PresetDeleteResponseDataConfigMediaVideo struct {
// Frame rate of participants' video
FrameRate int64 `json:"frame_rate" api:"required"`
// Video quality of participants
Quality PresetDeleteResponseDataConfigMediaVideoQuality `json:"quality" api:"required"`
JSON presetDeleteResponseDataConfigMediaVideoJSON `json:"-"`
}
Configuration options for participant videos
func (*PresetDeleteResponseDataConfigMediaVideo) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataConfigMediaVideo) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataConfigMediaVideoQuality ¶
type PresetDeleteResponseDataConfigMediaVideoQuality string
Video quality of participants
const ( PresetDeleteResponseDataConfigMediaVideoQualityHD PresetDeleteResponseDataConfigMediaVideoQuality = "hd" PresetDeleteResponseDataConfigMediaVideoQualityVga PresetDeleteResponseDataConfigMediaVideoQuality = "vga" PresetDeleteResponseDataConfigMediaVideoQualityQvga PresetDeleteResponseDataConfigMediaVideoQuality = "qvga" )
func (PresetDeleteResponseDataConfigMediaVideoQuality) IsKnown ¶
func (r PresetDeleteResponseDataConfigMediaVideoQuality) IsKnown() bool
type PresetDeleteResponseDataConfigViewType ¶
type PresetDeleteResponseDataConfigViewType string
Type of the meeting
const ( PresetDeleteResponseDataConfigViewTypeGroupCall PresetDeleteResponseDataConfigViewType = "GROUP_CALL" PresetDeleteResponseDataConfigViewTypeWebinar PresetDeleteResponseDataConfigViewType = "WEBINAR" PresetDeleteResponseDataConfigViewTypeAudioRoom PresetDeleteResponseDataConfigViewType = "AUDIO_ROOM" )
func (PresetDeleteResponseDataConfigViewType) IsKnown ¶
func (r PresetDeleteResponseDataConfigViewType) IsKnown() bool
type PresetDeleteResponseDataPermissions ¶
type PresetDeleteResponseDataPermissions struct {
// Whether this participant can accept waiting requests
AcceptWaitingRequests bool `json:"accept_waiting_requests" api:"required"`
CanAcceptProductionRequests bool `json:"can_accept_production_requests" api:"required"`
CanChangeParticipantPermissions bool `json:"can_change_participant_permissions" api:"required"`
CanEditDisplayName bool `json:"can_edit_display_name" api:"required"`
CanLivestream bool `json:"can_livestream" api:"required"`
CanRecord bool `json:"can_record" api:"required"`
CanSpotlight bool `json:"can_spotlight" api:"required"`
// Chat permissions
Chat PresetDeleteResponseDataPermissionsChat `json:"chat" api:"required"`
ConnectedMeetings PresetDeleteResponseDataPermissionsConnectedMeetings `json:"connected_meetings" api:"required"`
DisableParticipantAudio bool `json:"disable_participant_audio" api:"required"`
DisableParticipantScreensharing bool `json:"disable_participant_screensharing" api:"required"`
DisableParticipantVideo bool `json:"disable_participant_video" api:"required"`
// Whether this participant is visible to others or not
HiddenParticipant bool `json:"hidden_participant" api:"required"`
KickParticipant bool `json:"kick_participant" api:"required"`
// Media permissions
Media PresetDeleteResponseDataPermissionsMedia `json:"media" api:"required"`
PinParticipant bool `json:"pin_participant" api:"required"`
// Plugin permissions
Plugins PresetDeleteResponseDataPermissionsPlugins `json:"plugins" api:"required"`
// Poll permissions
Polls PresetDeleteResponseDataPermissionsPolls `json:"polls" api:"required"`
// Type of the recording peer
RecorderType PresetDeleteResponseDataPermissionsRecorderType `json:"recorder_type" api:"required"`
ShowParticipantList bool `json:"show_participant_list" api:"required"`
// Waiting room type
WaitingRoomType PresetDeleteResponseDataPermissionsWaitingRoomType `json:"waiting_room_type" api:"required"`
IsRecorder bool `json:"is_recorder"`
JSON presetDeleteResponseDataPermissionsJSON `json:"-"`
}
func (*PresetDeleteResponseDataPermissions) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissions) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsChat ¶
type PresetDeleteResponseDataPermissionsChat struct {
Private PresetDeleteResponseDataPermissionsChatPrivate `json:"private" api:"required"`
Public PresetDeleteResponseDataPermissionsChatPublic `json:"public" api:"required"`
JSON presetDeleteResponseDataPermissionsChatJSON `json:"-"`
}
Chat permissions
func (*PresetDeleteResponseDataPermissionsChat) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsChat) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsChatPrivate ¶
type PresetDeleteResponseDataPermissionsChatPrivate struct {
CanReceive bool `json:"can_receive" api:"required"`
CanSend bool `json:"can_send" api:"required"`
Files bool `json:"files" api:"required"`
Text bool `json:"text" api:"required"`
JSON presetDeleteResponseDataPermissionsChatPrivateJSON `json:"-"`
}
func (*PresetDeleteResponseDataPermissionsChatPrivate) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsChatPrivate) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsChatPublic ¶
type PresetDeleteResponseDataPermissionsChatPublic struct {
// Can send messages in general
CanSend bool `json:"can_send" api:"required"`
// Can send file messages
Files bool `json:"files" api:"required"`
// Can send text messages
Text bool `json:"text" api:"required"`
JSON presetDeleteResponseDataPermissionsChatPublicJSON `json:"-"`
}
func (*PresetDeleteResponseDataPermissionsChatPublic) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsChatPublic) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsConnectedMeetings ¶
type PresetDeleteResponseDataPermissionsConnectedMeetings struct {
CanAlterConnectedMeetings bool `json:"can_alter_connected_meetings" api:"required"`
CanSwitchConnectedMeetings bool `json:"can_switch_connected_meetings" api:"required"`
CanSwitchToParentMeeting bool `json:"can_switch_to_parent_meeting" api:"required"`
JSON presetDeleteResponseDataPermissionsConnectedMeetingsJSON `json:"-"`
}
func (*PresetDeleteResponseDataPermissionsConnectedMeetings) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsConnectedMeetings) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsMedia ¶
type PresetDeleteResponseDataPermissionsMedia struct {
// Audio permissions
Audio PresetDeleteResponseDataPermissionsMediaAudio `json:"audio" api:"required"`
Screenshare PresetDeleteResponseDataPermissionsMediaScreenshare `json:"screenshare" api:"required"`
// Video permissions
Video PresetDeleteResponseDataPermissionsMediaVideo `json:"video" api:"required"`
JSON presetDeleteResponseDataPermissionsMediaJSON `json:"-"`
}
Media permissions
func (*PresetDeleteResponseDataPermissionsMedia) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsMedia) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsMediaAudio ¶
type PresetDeleteResponseDataPermissionsMediaAudio struct {
// Can produce audio
CanProduce PresetDeleteResponseDataPermissionsMediaAudioCanProduce `json:"can_produce" api:"required"`
JSON presetDeleteResponseDataPermissionsMediaAudioJSON `json:"-"`
}
Audio permissions
func (*PresetDeleteResponseDataPermissionsMediaAudio) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsMediaAudio) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsMediaAudioCanProduce ¶
type PresetDeleteResponseDataPermissionsMediaAudioCanProduce string
Can produce audio
const ( PresetDeleteResponseDataPermissionsMediaAudioCanProduceAllowed PresetDeleteResponseDataPermissionsMediaAudioCanProduce = "ALLOWED" PresetDeleteResponseDataPermissionsMediaAudioCanProduceNotAllowed PresetDeleteResponseDataPermissionsMediaAudioCanProduce = "NOT_ALLOWED" PresetDeleteResponseDataPermissionsMediaAudioCanProduceCanRequest PresetDeleteResponseDataPermissionsMediaAudioCanProduce = "CAN_REQUEST" )
func (PresetDeleteResponseDataPermissionsMediaAudioCanProduce) IsKnown ¶
func (r PresetDeleteResponseDataPermissionsMediaAudioCanProduce) IsKnown() bool
type PresetDeleteResponseDataPermissionsMediaScreenshare ¶
type PresetDeleteResponseDataPermissionsMediaScreenshare struct {
// Can produce screen share video
}
Screenshare permissions
func (*PresetDeleteResponseDataPermissionsMediaScreenshare) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsMediaScreenshare) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce ¶
type PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce string
Can produce screen share video
const ( )
func (PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce) IsKnown ¶
func (r PresetDeleteResponseDataPermissionsMediaScreenshareCanProduce) IsKnown() bool
type PresetDeleteResponseDataPermissionsMediaVideo ¶
type PresetDeleteResponseDataPermissionsMediaVideo struct {
// Can produce video
CanProduce PresetDeleteResponseDataPermissionsMediaVideoCanProduce `json:"can_produce" api:"required"`
JSON presetDeleteResponseDataPermissionsMediaVideoJSON `json:"-"`
}
Video permissions
func (*PresetDeleteResponseDataPermissionsMediaVideo) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsMediaVideo) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsMediaVideoCanProduce ¶
type PresetDeleteResponseDataPermissionsMediaVideoCanProduce string
Can produce video
const ( PresetDeleteResponseDataPermissionsMediaVideoCanProduceAllowed PresetDeleteResponseDataPermissionsMediaVideoCanProduce = "ALLOWED" PresetDeleteResponseDataPermissionsMediaVideoCanProduceNotAllowed PresetDeleteResponseDataPermissionsMediaVideoCanProduce = "NOT_ALLOWED" PresetDeleteResponseDataPermissionsMediaVideoCanProduceCanRequest PresetDeleteResponseDataPermissionsMediaVideoCanProduce = "CAN_REQUEST" )
func (PresetDeleteResponseDataPermissionsMediaVideoCanProduce) IsKnown ¶
func (r PresetDeleteResponseDataPermissionsMediaVideoCanProduce) IsKnown() bool
type PresetDeleteResponseDataPermissionsPlugins ¶
type PresetDeleteResponseDataPermissionsPlugins struct {
// Can close plugins that are already open
CanClose bool `json:"can_close" api:"required"`
// Can edit plugin config
CanEditConfig bool `json:"can_edit_config" api:"required"`
// Can start plugins
CanStart bool `json:"can_start" api:"required"`
Config PresetDeleteResponseDataPermissionsPluginsConfigUnion `json:"config" api:"required" format:"uuid"`
JSON presetDeleteResponseDataPermissionsPluginsJSON `json:"-"`
}
Plugin permissions
func (*PresetDeleteResponseDataPermissionsPlugins) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsPlugins) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsPluginsConfigObject ¶
type PresetDeleteResponseDataPermissionsPluginsConfigObject struct {
AccessControl PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl `json:"access_control" api:"required"`
HandlesViewOnly bool `json:"handles_view_only" api:"required"`
JSON presetDeleteResponseDataPermissionsPluginsConfigObjectJSON `json:"-"`
}
func (PresetDeleteResponseDataPermissionsPluginsConfigObject) ImplementsPresetDeleteResponseDataPermissionsPluginsConfigUnion ¶
func (r PresetDeleteResponseDataPermissionsPluginsConfigObject) ImplementsPresetDeleteResponseDataPermissionsPluginsConfigUnion()
func (*PresetDeleteResponseDataPermissionsPluginsConfigObject) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsPluginsConfigObject) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl ¶
type PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl string
const ( PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControlFullAccess PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS" PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControlViewOnly PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY" )
func (PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown ¶
func (r PresetDeleteResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown() bool
type PresetDeleteResponseDataPermissionsPluginsConfigUnion ¶
type PresetDeleteResponseDataPermissionsPluginsConfigUnion interface {
ImplementsPresetDeleteResponseDataPermissionsPluginsConfigUnion()
}
Union satisfied by shared.UnionString or PresetDeleteResponseDataPermissionsPluginsConfigObject.
type PresetDeleteResponseDataPermissionsPolls ¶
type PresetDeleteResponseDataPermissionsPolls struct {
// Can create polls
CanCreate bool `json:"can_create" api:"required"`
// Can view polls
CanView bool `json:"can_view" api:"required"`
// Can vote on polls
CanVote bool `json:"can_vote" api:"required"`
JSON presetDeleteResponseDataPermissionsPollsJSON `json:"-"`
}
Poll permissions
func (*PresetDeleteResponseDataPermissionsPolls) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataPermissionsPolls) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataPermissionsRecorderType ¶
type PresetDeleteResponseDataPermissionsRecorderType string
Type of the recording peer
const ( PresetDeleteResponseDataPermissionsRecorderTypeRecorder PresetDeleteResponseDataPermissionsRecorderType = "RECORDER" PresetDeleteResponseDataPermissionsRecorderTypeLivestreamer PresetDeleteResponseDataPermissionsRecorderType = "LIVESTREAMER" PresetDeleteResponseDataPermissionsRecorderTypeNone PresetDeleteResponseDataPermissionsRecorderType = "NONE" )
func (PresetDeleteResponseDataPermissionsRecorderType) IsKnown ¶
func (r PresetDeleteResponseDataPermissionsRecorderType) IsKnown() bool
type PresetDeleteResponseDataPermissionsWaitingRoomType ¶
type PresetDeleteResponseDataPermissionsWaitingRoomType string
Waiting room type
const ( PresetDeleteResponseDataPermissionsWaitingRoomTypeSkip PresetDeleteResponseDataPermissionsWaitingRoomType = "SKIP" PresetDeleteResponseDataPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetDeleteResponseDataPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY" PresetDeleteResponseDataPermissionsWaitingRoomTypeSkipOnAccept PresetDeleteResponseDataPermissionsWaitingRoomType = "SKIP_ON_ACCEPT" )
func (PresetDeleteResponseDataPermissionsWaitingRoomType) IsKnown ¶
func (r PresetDeleteResponseDataPermissionsWaitingRoomType) IsKnown() bool
type PresetDeleteResponseDataUI ¶
type PresetDeleteResponseDataUI struct {
DesignTokens PresetDeleteResponseDataUIDesignTokens `json:"design_tokens" api:"required"`
ConfigDiff interface{} `json:"config_diff"`
JSON presetDeleteResponseDataUIJSON `json:"-"`
}
func (*PresetDeleteResponseDataUI) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataUI) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataUIDesignTokens ¶
type PresetDeleteResponseDataUIDesignTokens struct {
BorderRadius PresetDeleteResponseDataUIDesignTokensBorderRadius `json:"border_radius" api:"required"`
BorderWidth PresetDeleteResponseDataUIDesignTokensBorderWidth `json:"border_width" api:"required"`
Colors PresetDeleteResponseDataUIDesignTokensColors `json:"colors" api:"required"`
Logo string `json:"logo" api:"required"`
SpacingBase float64 `json:"spacing_base" api:"required"`
Theme PresetDeleteResponseDataUIDesignTokensTheme `json:"theme" api:"required"`
JSON presetDeleteResponseDataUIDesignTokensJSON `json:"-"`
}
func (*PresetDeleteResponseDataUIDesignTokens) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataUIDesignTokens) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataUIDesignTokensBorderRadius ¶
type PresetDeleteResponseDataUIDesignTokensBorderRadius string
const (
PresetDeleteResponseDataUIDesignTokensBorderRadiusRounded PresetDeleteResponseDataUIDesignTokensBorderRadius = "rounded"
)
func (PresetDeleteResponseDataUIDesignTokensBorderRadius) IsKnown ¶
func (r PresetDeleteResponseDataUIDesignTokensBorderRadius) IsKnown() bool
type PresetDeleteResponseDataUIDesignTokensBorderWidth ¶
type PresetDeleteResponseDataUIDesignTokensBorderWidth string
const (
PresetDeleteResponseDataUIDesignTokensBorderWidthThin PresetDeleteResponseDataUIDesignTokensBorderWidth = "thin"
)
func (PresetDeleteResponseDataUIDesignTokensBorderWidth) IsKnown ¶
func (r PresetDeleteResponseDataUIDesignTokensBorderWidth) IsKnown() bool
type PresetDeleteResponseDataUIDesignTokensColors ¶
type PresetDeleteResponseDataUIDesignTokensColors struct {
Background PresetDeleteResponseDataUIDesignTokensColorsBackground `json:"background" api:"required"`
Brand PresetDeleteResponseDataUIDesignTokensColorsBrand `json:"brand" api:"required"`
Danger string `json:"danger" api:"required"`
Success string `json:"success" api:"required"`
Text string `json:"text" api:"required"`
TextOnBrand string `json:"text_on_brand" api:"required"`
VideoBg string `json:"video_bg" api:"required"`
Warning string `json:"warning" api:"required"`
JSON presetDeleteResponseDataUIDesignTokensColorsJSON `json:"-"`
}
func (*PresetDeleteResponseDataUIDesignTokensColors) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataUIDesignTokensColors) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataUIDesignTokensColorsBackground ¶
type PresetDeleteResponseDataUIDesignTokensColorsBackground struct {
Number1000 string `json:"1000" api:"required"`
Number600 string `json:"600" api:"required"`
Number700 string `json:"700" api:"required"`
Number800 string `json:"800" api:"required"`
Number900 string `json:"900" api:"required"`
JSON presetDeleteResponseDataUIDesignTokensColorsBackgroundJSON `json:"-"`
}
func (*PresetDeleteResponseDataUIDesignTokensColorsBackground) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataUIDesignTokensColorsBackground) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataUIDesignTokensColorsBrand ¶
type PresetDeleteResponseDataUIDesignTokensColorsBrand struct {
Number300 string `json:"300" api:"required"`
Number400 string `json:"400" api:"required"`
Number500 string `json:"500" api:"required"`
Number600 string `json:"600" api:"required"`
Number700 string `json:"700" api:"required"`
JSON presetDeleteResponseDataUIDesignTokensColorsBrandJSON `json:"-"`
}
func (*PresetDeleteResponseDataUIDesignTokensColorsBrand) UnmarshalJSON ¶
func (r *PresetDeleteResponseDataUIDesignTokensColorsBrand) UnmarshalJSON(data []byte) (err error)
type PresetDeleteResponseDataUIDesignTokensTheme ¶
type PresetDeleteResponseDataUIDesignTokensTheme string
const (
PresetDeleteResponseDataUIDesignTokensThemeDark PresetDeleteResponseDataUIDesignTokensTheme = "dark"
)
func (PresetDeleteResponseDataUIDesignTokensTheme) IsKnown ¶
func (r PresetDeleteResponseDataUIDesignTokensTheme) IsKnown() bool
type PresetGetParams ¶
type PresetGetParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// The page number from which you want your page search results to be displayed.
PageNo param.Field[float64] `query:"page_no"`
// Number of results per page
PerPage param.Field[float64] `query:"per_page"`
}
func (PresetGetParams) URLQuery ¶
func (r PresetGetParams) URLQuery() (v url.Values)
URLQuery serializes PresetGetParams's query parameters as `url.Values`.
type PresetGetPresetByIDResponse ¶
type PresetGetPresetByIDResponse struct {
// Data returned by the operation
Data PresetGetPresetByIDResponseData `json:"data" api:"required"`
// Success status of the operation
Success bool `json:"success" api:"required"`
JSON presetGetPresetByIDResponseJSON `json:"-"`
}
func (*PresetGetPresetByIDResponse) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponse) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseData ¶
type PresetGetPresetByIDResponseData struct {
// ID of the preset
ID string `json:"id" api:"required" format:"uuid"`
Config PresetGetPresetByIDResponseDataConfig `json:"config" api:"required"`
// Name of the preset
Name string `json:"name" api:"required"`
UI PresetGetPresetByIDResponseDataUI `json:"ui" api:"required"`
Permissions PresetGetPresetByIDResponseDataPermissions `json:"permissions"`
JSON presetGetPresetByIDResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*PresetGetPresetByIDResponseData) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseData) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataConfig ¶
type PresetGetPresetByIDResponseDataConfig struct {
MaxScreenshareCount int64 `json:"max_screenshare_count" api:"required"`
// Maximum number of streams that are visible on a device
MaxVideoStreams PresetGetPresetByIDResponseDataConfigMaxVideoStreams `json:"max_video_streams" api:"required"`
// Media configuration options. eg: Video quality
Media PresetGetPresetByIDResponseDataConfigMedia `json:"media" api:"required"`
// Type of the meeting
ViewType PresetGetPresetByIDResponseDataConfigViewType `json:"view_type" api:"required"`
JSON presetGetPresetByIDResponseDataConfigJSON `json:"-"`
}
func (*PresetGetPresetByIDResponseDataConfig) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataConfig) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataConfigMaxVideoStreams ¶
type PresetGetPresetByIDResponseDataConfigMaxVideoStreams struct {
// Maximum number of video streams visible on desktop devices
Desktop int64 `json:"desktop" api:"required"`
// Maximum number of streams visible on mobile devices
Mobile int64 `json:"mobile" api:"required"`
JSON presetGetPresetByIDResponseDataConfigMaxVideoStreamsJSON `json:"-"`
}
Maximum number of streams that are visible on a device
func (*PresetGetPresetByIDResponseDataConfigMaxVideoStreams) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataConfigMaxVideoStreams) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataConfigMedia ¶
type PresetGetPresetByIDResponseDataConfigMedia struct {
Screenshare PresetGetPresetByIDResponseDataConfigMediaScreenshare `json:"screenshare" api:"required"`
// Configuration options for participant videos
Video PresetGetPresetByIDResponseDataConfigMediaVideo `json:"video" api:"required"`
// Control options for Audio quality.
Audio PresetGetPresetByIDResponseDataConfigMediaAudio `json:"audio"`
JSON presetGetPresetByIDResponseDataConfigMediaJSON `json:"-"`
}
Media configuration options. eg: Video quality
func (*PresetGetPresetByIDResponseDataConfigMedia) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataConfigMedia) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataConfigMediaAudio ¶
type PresetGetPresetByIDResponseDataConfigMediaAudio struct {
// Enable High Quality Audio for your meetings
EnableHighBitrate bool `json:"enable_high_bitrate"`
// Enable Stereo for your meetings
EnableStereo bool `json:"enable_stereo"`
JSON presetGetPresetByIDResponseDataConfigMediaAudioJSON `json:"-"`
}
Control options for Audio quality.
func (*PresetGetPresetByIDResponseDataConfigMediaAudio) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataConfigMediaAudio) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataConfigMediaScreenshare ¶
type PresetGetPresetByIDResponseDataConfigMediaScreenshare struct {
FrameRate int64 `json:"frame_rate" api:"required"`
// Quality of screen share
}
Configuration options for participant screen shares
func (*PresetGetPresetByIDResponseDataConfigMediaScreenshare) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataConfigMediaScreenshare) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality ¶
type PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality string
Quality of screen share
const ( )
func (PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality) IsKnown ¶
func (r PresetGetPresetByIDResponseDataConfigMediaScreenshareQuality) IsKnown() bool
type PresetGetPresetByIDResponseDataConfigMediaVideo ¶
type PresetGetPresetByIDResponseDataConfigMediaVideo struct {
// Frame rate of participants' video
FrameRate int64 `json:"frame_rate" api:"required"`
// Video quality of participants
Quality PresetGetPresetByIDResponseDataConfigMediaVideoQuality `json:"quality" api:"required"`
JSON presetGetPresetByIDResponseDataConfigMediaVideoJSON `json:"-"`
}
Configuration options for participant videos
func (*PresetGetPresetByIDResponseDataConfigMediaVideo) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataConfigMediaVideo) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataConfigMediaVideoQuality ¶
type PresetGetPresetByIDResponseDataConfigMediaVideoQuality string
Video quality of participants
const ( PresetGetPresetByIDResponseDataConfigMediaVideoQualityHD PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "hd" PresetGetPresetByIDResponseDataConfigMediaVideoQualityVga PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "vga" PresetGetPresetByIDResponseDataConfigMediaVideoQualityQvga PresetGetPresetByIDResponseDataConfigMediaVideoQuality = "qvga" )
func (PresetGetPresetByIDResponseDataConfigMediaVideoQuality) IsKnown ¶
func (r PresetGetPresetByIDResponseDataConfigMediaVideoQuality) IsKnown() bool
type PresetGetPresetByIDResponseDataConfigViewType ¶
type PresetGetPresetByIDResponseDataConfigViewType string
Type of the meeting
const ( PresetGetPresetByIDResponseDataConfigViewTypeGroupCall PresetGetPresetByIDResponseDataConfigViewType = "GROUP_CALL" PresetGetPresetByIDResponseDataConfigViewTypeWebinar PresetGetPresetByIDResponseDataConfigViewType = "WEBINAR" PresetGetPresetByIDResponseDataConfigViewTypeAudioRoom PresetGetPresetByIDResponseDataConfigViewType = "AUDIO_ROOM" )
func (PresetGetPresetByIDResponseDataConfigViewType) IsKnown ¶
func (r PresetGetPresetByIDResponseDataConfigViewType) IsKnown() bool
type PresetGetPresetByIDResponseDataPermissions ¶
type PresetGetPresetByIDResponseDataPermissions struct {
// Whether this participant can accept waiting requests
AcceptWaitingRequests bool `json:"accept_waiting_requests" api:"required"`
CanAcceptProductionRequests bool `json:"can_accept_production_requests" api:"required"`
CanChangeParticipantPermissions bool `json:"can_change_participant_permissions" api:"required"`
CanEditDisplayName bool `json:"can_edit_display_name" api:"required"`
CanLivestream bool `json:"can_livestream" api:"required"`
CanRecord bool `json:"can_record" api:"required"`
CanSpotlight bool `json:"can_spotlight" api:"required"`
// Chat permissions
Chat PresetGetPresetByIDResponseDataPermissionsChat `json:"chat" api:"required"`
ConnectedMeetings PresetGetPresetByIDResponseDataPermissionsConnectedMeetings `json:"connected_meetings" api:"required"`
DisableParticipantAudio bool `json:"disable_participant_audio" api:"required"`
DisableParticipantScreensharing bool `json:"disable_participant_screensharing" api:"required"`
DisableParticipantVideo bool `json:"disable_participant_video" api:"required"`
// Whether this participant is visible to others or not
HiddenParticipant bool `json:"hidden_participant" api:"required"`
KickParticipant bool `json:"kick_participant" api:"required"`
// Media permissions
Media PresetGetPresetByIDResponseDataPermissionsMedia `json:"media" api:"required"`
PinParticipant bool `json:"pin_participant" api:"required"`
// Plugin permissions
Plugins PresetGetPresetByIDResponseDataPermissionsPlugins `json:"plugins" api:"required"`
// Poll permissions
Polls PresetGetPresetByIDResponseDataPermissionsPolls `json:"polls" api:"required"`
// Type of the recording peer
RecorderType PresetGetPresetByIDResponseDataPermissionsRecorderType `json:"recorder_type" api:"required"`
ShowParticipantList bool `json:"show_participant_list" api:"required"`
// Waiting room type
WaitingRoomType PresetGetPresetByIDResponseDataPermissionsWaitingRoomType `json:"waiting_room_type" api:"required"`
IsRecorder bool `json:"is_recorder"`
JSON presetGetPresetByIDResponseDataPermissionsJSON `json:"-"`
}
func (*PresetGetPresetByIDResponseDataPermissions) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissions) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsChat ¶
type PresetGetPresetByIDResponseDataPermissionsChat struct {
Private PresetGetPresetByIDResponseDataPermissionsChatPrivate `json:"private" api:"required"`
Public PresetGetPresetByIDResponseDataPermissionsChatPublic `json:"public" api:"required"`
JSON presetGetPresetByIDResponseDataPermissionsChatJSON `json:"-"`
}
Chat permissions
func (*PresetGetPresetByIDResponseDataPermissionsChat) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsChat) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsChatPrivate ¶
type PresetGetPresetByIDResponseDataPermissionsChatPrivate struct {
CanReceive bool `json:"can_receive" api:"required"`
CanSend bool `json:"can_send" api:"required"`
Files bool `json:"files" api:"required"`
Text bool `json:"text" api:"required"`
JSON presetGetPresetByIDResponseDataPermissionsChatPrivateJSON `json:"-"`
}
func (*PresetGetPresetByIDResponseDataPermissionsChatPrivate) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsChatPrivate) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsChatPublic ¶
type PresetGetPresetByIDResponseDataPermissionsChatPublic struct {
// Can send messages in general
CanSend bool `json:"can_send" api:"required"`
// Can send file messages
Files bool `json:"files" api:"required"`
// Can send text messages
Text bool `json:"text" api:"required"`
JSON presetGetPresetByIDResponseDataPermissionsChatPublicJSON `json:"-"`
}
func (*PresetGetPresetByIDResponseDataPermissionsChatPublic) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsChatPublic) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsConnectedMeetings ¶
type PresetGetPresetByIDResponseDataPermissionsConnectedMeetings struct {
CanAlterConnectedMeetings bool `json:"can_alter_connected_meetings" api:"required"`
CanSwitchConnectedMeetings bool `json:"can_switch_connected_meetings" api:"required"`
CanSwitchToParentMeeting bool `json:"can_switch_to_parent_meeting" api:"required"`
JSON presetGetPresetByIDResponseDataPermissionsConnectedMeetingsJSON `json:"-"`
}
func (*PresetGetPresetByIDResponseDataPermissionsConnectedMeetings) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsConnectedMeetings) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsMedia ¶
type PresetGetPresetByIDResponseDataPermissionsMedia struct {
// Audio permissions
Audio PresetGetPresetByIDResponseDataPermissionsMediaAudio `json:"audio" api:"required"`
Screenshare PresetGetPresetByIDResponseDataPermissionsMediaScreenshare `json:"screenshare" api:"required"`
// Video permissions
Video PresetGetPresetByIDResponseDataPermissionsMediaVideo `json:"video" api:"required"`
JSON presetGetPresetByIDResponseDataPermissionsMediaJSON `json:"-"`
}
Media permissions
func (*PresetGetPresetByIDResponseDataPermissionsMedia) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsMedia) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsMediaAudio ¶
type PresetGetPresetByIDResponseDataPermissionsMediaAudio struct {
// Can produce audio
CanProduce PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce `json:"can_produce" api:"required"`
JSON presetGetPresetByIDResponseDataPermissionsMediaAudioJSON `json:"-"`
}
Audio permissions
func (*PresetGetPresetByIDResponseDataPermissionsMediaAudio) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsMediaAudio) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce ¶
type PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce string
Can produce audio
const ( PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduceAllowed PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce = "ALLOWED" PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduceNotAllowed PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce = "NOT_ALLOWED" PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduceCanRequest PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce = "CAN_REQUEST" )
func (PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce) IsKnown ¶
func (r PresetGetPresetByIDResponseDataPermissionsMediaAudioCanProduce) IsKnown() bool
type PresetGetPresetByIDResponseDataPermissionsMediaScreenshare ¶
type PresetGetPresetByIDResponseDataPermissionsMediaScreenshare struct {
// Can produce screen share video
}
Screenshare permissions
func (*PresetGetPresetByIDResponseDataPermissionsMediaScreenshare) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsMediaScreenshare) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce ¶
type PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce string
Can produce screen share video
const ( )
func (PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce) IsKnown ¶
func (r PresetGetPresetByIDResponseDataPermissionsMediaScreenshareCanProduce) IsKnown() bool
type PresetGetPresetByIDResponseDataPermissionsMediaVideo ¶
type PresetGetPresetByIDResponseDataPermissionsMediaVideo struct {
// Can produce video
CanProduce PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce `json:"can_produce" api:"required"`
JSON presetGetPresetByIDResponseDataPermissionsMediaVideoJSON `json:"-"`
}
Video permissions
func (*PresetGetPresetByIDResponseDataPermissionsMediaVideo) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsMediaVideo) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce ¶
type PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce string
Can produce video
const ( PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduceAllowed PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce = "ALLOWED" PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduceNotAllowed PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce = "NOT_ALLOWED" PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduceCanRequest PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce = "CAN_REQUEST" )
func (PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce) IsKnown ¶
func (r PresetGetPresetByIDResponseDataPermissionsMediaVideoCanProduce) IsKnown() bool
type PresetGetPresetByIDResponseDataPermissionsPlugins ¶
type PresetGetPresetByIDResponseDataPermissionsPlugins struct {
// Can close plugins that are already open
CanClose bool `json:"can_close" api:"required"`
// Can edit plugin config
CanEditConfig bool `json:"can_edit_config" api:"required"`
// Can start plugins
CanStart bool `json:"can_start" api:"required"`
Config PresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion `json:"config" api:"required" format:"uuid"`
JSON presetGetPresetByIDResponseDataPermissionsPluginsJSON `json:"-"`
}
Plugin permissions
func (*PresetGetPresetByIDResponseDataPermissionsPlugins) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsPlugins) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject ¶
type PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject struct {
AccessControl PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl `json:"access_control" api:"required"`
HandlesViewOnly bool `json:"handles_view_only" api:"required"`
JSON presetGetPresetByIDResponseDataPermissionsPluginsConfigObjectJSON `json:"-"`
}
func (PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject) ImplementsPresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion ¶
func (r PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject) ImplementsPresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion()
func (*PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl ¶
type PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl string
const ( PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControlFullAccess PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS" PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControlViewOnly PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY" )
func (PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown ¶
func (r PresetGetPresetByIDResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown() bool
type PresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion ¶
type PresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion interface {
ImplementsPresetGetPresetByIDResponseDataPermissionsPluginsConfigUnion()
}
Union satisfied by shared.UnionString or PresetGetPresetByIDResponseDataPermissionsPluginsConfigObject.
type PresetGetPresetByIDResponseDataPermissionsPolls ¶
type PresetGetPresetByIDResponseDataPermissionsPolls struct {
// Can create polls
CanCreate bool `json:"can_create" api:"required"`
// Can view polls
CanView bool `json:"can_view" api:"required"`
// Can vote on polls
CanVote bool `json:"can_vote" api:"required"`
JSON presetGetPresetByIDResponseDataPermissionsPollsJSON `json:"-"`
}
Poll permissions
func (*PresetGetPresetByIDResponseDataPermissionsPolls) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataPermissionsPolls) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataPermissionsRecorderType ¶
type PresetGetPresetByIDResponseDataPermissionsRecorderType string
Type of the recording peer
const ( PresetGetPresetByIDResponseDataPermissionsRecorderTypeRecorder PresetGetPresetByIDResponseDataPermissionsRecorderType = "RECORDER" PresetGetPresetByIDResponseDataPermissionsRecorderTypeLivestreamer PresetGetPresetByIDResponseDataPermissionsRecorderType = "LIVESTREAMER" PresetGetPresetByIDResponseDataPermissionsRecorderTypeNone PresetGetPresetByIDResponseDataPermissionsRecorderType = "NONE" )
func (PresetGetPresetByIDResponseDataPermissionsRecorderType) IsKnown ¶
func (r PresetGetPresetByIDResponseDataPermissionsRecorderType) IsKnown() bool
type PresetGetPresetByIDResponseDataPermissionsWaitingRoomType ¶
type PresetGetPresetByIDResponseDataPermissionsWaitingRoomType string
Waiting room type
const ( PresetGetPresetByIDResponseDataPermissionsWaitingRoomTypeSkip PresetGetPresetByIDResponseDataPermissionsWaitingRoomType = "SKIP" PresetGetPresetByIDResponseDataPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetGetPresetByIDResponseDataPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY" PresetGetPresetByIDResponseDataPermissionsWaitingRoomTypeSkipOnAccept PresetGetPresetByIDResponseDataPermissionsWaitingRoomType = "SKIP_ON_ACCEPT" )
func (PresetGetPresetByIDResponseDataPermissionsWaitingRoomType) IsKnown ¶
func (r PresetGetPresetByIDResponseDataPermissionsWaitingRoomType) IsKnown() bool
type PresetGetPresetByIDResponseDataUI ¶
type PresetGetPresetByIDResponseDataUI struct {
DesignTokens PresetGetPresetByIDResponseDataUIDesignTokens `json:"design_tokens" api:"required"`
ConfigDiff interface{} `json:"config_diff"`
JSON presetGetPresetByIDResponseDataUIJSON `json:"-"`
}
func (*PresetGetPresetByIDResponseDataUI) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataUI) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataUIDesignTokens ¶
type PresetGetPresetByIDResponseDataUIDesignTokens struct {
BorderRadius PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius `json:"border_radius" api:"required"`
BorderWidth PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth `json:"border_width" api:"required"`
Colors PresetGetPresetByIDResponseDataUIDesignTokensColors `json:"colors" api:"required"`
Logo string `json:"logo" api:"required"`
SpacingBase float64 `json:"spacing_base" api:"required"`
Theme PresetGetPresetByIDResponseDataUIDesignTokensTheme `json:"theme" api:"required"`
JSON presetGetPresetByIDResponseDataUIDesignTokensJSON `json:"-"`
}
func (*PresetGetPresetByIDResponseDataUIDesignTokens) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataUIDesignTokens) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius ¶
type PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius string
const (
PresetGetPresetByIDResponseDataUIDesignTokensBorderRadiusRounded PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius = "rounded"
)
func (PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius) IsKnown ¶
func (r PresetGetPresetByIDResponseDataUIDesignTokensBorderRadius) IsKnown() bool
type PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth ¶
type PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth string
const (
PresetGetPresetByIDResponseDataUIDesignTokensBorderWidthThin PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth = "thin"
)
func (PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth) IsKnown ¶
func (r PresetGetPresetByIDResponseDataUIDesignTokensBorderWidth) IsKnown() bool
type PresetGetPresetByIDResponseDataUIDesignTokensColors ¶
type PresetGetPresetByIDResponseDataUIDesignTokensColors struct {
Background PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground `json:"background" api:"required"`
Brand PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand `json:"brand" api:"required"`
Danger string `json:"danger" api:"required"`
Success string `json:"success" api:"required"`
Text string `json:"text" api:"required"`
TextOnBrand string `json:"text_on_brand" api:"required"`
VideoBg string `json:"video_bg" api:"required"`
Warning string `json:"warning" api:"required"`
JSON presetGetPresetByIDResponseDataUIDesignTokensColorsJSON `json:"-"`
}
func (*PresetGetPresetByIDResponseDataUIDesignTokensColors) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataUIDesignTokensColors) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground ¶
type PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground struct {
Number1000 string `json:"1000" api:"required"`
Number600 string `json:"600" api:"required"`
Number700 string `json:"700" api:"required"`
Number800 string `json:"800" api:"required"`
Number900 string `json:"900" api:"required"`
JSON presetGetPresetByIDResponseDataUIDesignTokensColorsBackgroundJSON `json:"-"`
}
func (*PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataUIDesignTokensColorsBackground) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand ¶
type PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand struct {
Number300 string `json:"300" api:"required"`
Number400 string `json:"400" api:"required"`
Number500 string `json:"500" api:"required"`
Number600 string `json:"600" api:"required"`
Number700 string `json:"700" api:"required"`
JSON presetGetPresetByIDResponseDataUIDesignTokensColorsBrandJSON `json:"-"`
}
func (*PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand) UnmarshalJSON ¶
func (r *PresetGetPresetByIDResponseDataUIDesignTokensColorsBrand) UnmarshalJSON(data []byte) (err error)
type PresetGetPresetByIDResponseDataUIDesignTokensTheme ¶
type PresetGetPresetByIDResponseDataUIDesignTokensTheme string
const (
PresetGetPresetByIDResponseDataUIDesignTokensThemeDark PresetGetPresetByIDResponseDataUIDesignTokensTheme = "dark"
)
func (PresetGetPresetByIDResponseDataUIDesignTokensTheme) IsKnown ¶
func (r PresetGetPresetByIDResponseDataUIDesignTokensTheme) IsKnown() bool
type PresetGetResponse ¶
type PresetGetResponse struct {
Data []PresetGetResponseData `json:"data" api:"required"`
Paging PresetGetResponsePaging `json:"paging" api:"required"`
Success bool `json:"success" api:"required"`
JSON presetGetResponseJSON `json:"-"`
}
func (*PresetGetResponse) UnmarshalJSON ¶
func (r *PresetGetResponse) UnmarshalJSON(data []byte) (err error)
type PresetGetResponseData ¶
type PresetGetResponseData struct {
// ID of the preset
ID string `json:"id" format:"uuid"`
// Timestamp this preset was created at
CreatedAt time.Time `json:"created_at" format:"date-time"`
// Name of the preset
Name string `json:"name"`
// Timestamp this preset was last updated
UpdatedAt time.Time `json:"updated_at" format:"date-time"`
JSON presetGetResponseDataJSON `json:"-"`
}
Returned by Get All Presets route
func (*PresetGetResponseData) UnmarshalJSON ¶
func (r *PresetGetResponseData) UnmarshalJSON(data []byte) (err error)
type PresetGetResponsePaging ¶
type PresetGetResponsePaging struct {
EndOffset float64 `json:"end_offset" api:"required"`
StartOffset float64 `json:"start_offset" api:"required"`
TotalCount float64 `json:"total_count" api:"required"`
JSON presetGetResponsePagingJSON `json:"-"`
}
func (*PresetGetResponsePaging) UnmarshalJSON ¶
func (r *PresetGetResponsePaging) UnmarshalJSON(data []byte) (err error)
type PresetNewParams ¶
type PresetNewParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
Config param.Field[PresetNewParamsConfig] `json:"config" api:"required"`
// Name of the preset
Name param.Field[string] `json:"name" api:"required"`
UI param.Field[PresetNewParamsUI] `json:"ui" api:"required"`
Permissions param.Field[PresetNewParamsPermissions] `json:"permissions"`
}
func (PresetNewParams) MarshalJSON ¶
func (r PresetNewParams) MarshalJSON() (data []byte, err error)
type PresetNewParamsConfig ¶
type PresetNewParamsConfig struct {
MaxScreenshareCount param.Field[int64] `json:"max_screenshare_count" api:"required"`
// Maximum number of streams that are visible on a device
MaxVideoStreams param.Field[PresetNewParamsConfigMaxVideoStreams] `json:"max_video_streams" api:"required"`
// Media configuration options. eg: Video quality
Media param.Field[PresetNewParamsConfigMedia] `json:"media" api:"required"`
// Type of the meeting
ViewType param.Field[PresetNewParamsConfigViewType] `json:"view_type" api:"required"`
}
func (PresetNewParamsConfig) MarshalJSON ¶
func (r PresetNewParamsConfig) MarshalJSON() (data []byte, err error)
type PresetNewParamsConfigMaxVideoStreams ¶
type PresetNewParamsConfigMaxVideoStreams struct {
// Maximum number of video streams visible on desktop devices
Desktop param.Field[int64] `json:"desktop" api:"required"`
// Maximum number of streams visible on mobile devices
Mobile param.Field[int64] `json:"mobile" api:"required"`
}
Maximum number of streams that are visible on a device
func (PresetNewParamsConfigMaxVideoStreams) MarshalJSON ¶
func (r PresetNewParamsConfigMaxVideoStreams) MarshalJSON() (data []byte, err error)
type PresetNewParamsConfigMedia ¶
type PresetNewParamsConfigMedia struct {
Screenshare param.Field[PresetNewParamsConfigMediaScreenshare] `json:"screenshare" api:"required"`
// Configuration options for participant videos
Video param.Field[PresetNewParamsConfigMediaVideo] `json:"video" api:"required"`
// Control options for Audio quality.
Audio param.Field[PresetNewParamsConfigMediaAudio] `json:"audio"`
}
Media configuration options. eg: Video quality
func (PresetNewParamsConfigMedia) MarshalJSON ¶
func (r PresetNewParamsConfigMedia) MarshalJSON() (data []byte, err error)
type PresetNewParamsConfigMediaAudio ¶
type PresetNewParamsConfigMediaAudio struct {
// Enable High Quality Audio for your meetings
EnableHighBitrate param.Field[bool] `json:"enable_high_bitrate"`
// Enable Stereo for your meetings
EnableStereo param.Field[bool] `json:"enable_stereo"`
}
Control options for Audio quality.
func (PresetNewParamsConfigMediaAudio) MarshalJSON ¶
func (r PresetNewParamsConfigMediaAudio) MarshalJSON() (data []byte, err error)
type PresetNewParamsConfigMediaScreenshare ¶
type PresetNewParamsConfigMediaScreenshare struct {
FrameRate param.Field[int64] `json:"frame_rate" api:"required"`
Quality param.Field[PresetNewParamsConfigMediaScreenshareQuality] `json:"quality" api:"required"`
}
Configuration options for participant screen shares
func (PresetNewParamsConfigMediaScreenshare) MarshalJSON ¶
func (r PresetNewParamsConfigMediaScreenshare) MarshalJSON() (data []byte, err error)
type PresetNewParamsConfigMediaScreenshareQuality ¶
type PresetNewParamsConfigMediaScreenshareQuality string
Quality of screen share
const ( )
func (PresetNewParamsConfigMediaScreenshareQuality) IsKnown ¶
func (r PresetNewParamsConfigMediaScreenshareQuality) IsKnown() bool
type PresetNewParamsConfigMediaVideo ¶
type PresetNewParamsConfigMediaVideo struct {
// Frame rate of participants' video
FrameRate param.Field[int64] `json:"frame_rate" api:"required"`
// Video quality of participants
Quality param.Field[PresetNewParamsConfigMediaVideoQuality] `json:"quality" api:"required"`
}
Configuration options for participant videos
func (PresetNewParamsConfigMediaVideo) MarshalJSON ¶
func (r PresetNewParamsConfigMediaVideo) MarshalJSON() (data []byte, err error)
type PresetNewParamsConfigMediaVideoQuality ¶
type PresetNewParamsConfigMediaVideoQuality string
Video quality of participants
const ( PresetNewParamsConfigMediaVideoQualityHD PresetNewParamsConfigMediaVideoQuality = "hd" PresetNewParamsConfigMediaVideoQualityVga PresetNewParamsConfigMediaVideoQuality = "vga" PresetNewParamsConfigMediaVideoQualityQvga PresetNewParamsConfigMediaVideoQuality = "qvga" )
func (PresetNewParamsConfigMediaVideoQuality) IsKnown ¶
func (r PresetNewParamsConfigMediaVideoQuality) IsKnown() bool
type PresetNewParamsConfigViewType ¶
type PresetNewParamsConfigViewType string
Type of the meeting
const ( PresetNewParamsConfigViewTypeGroupCall PresetNewParamsConfigViewType = "GROUP_CALL" PresetNewParamsConfigViewTypeWebinar PresetNewParamsConfigViewType = "WEBINAR" PresetNewParamsConfigViewTypeAudioRoom PresetNewParamsConfigViewType = "AUDIO_ROOM" )
func (PresetNewParamsConfigViewType) IsKnown ¶
func (r PresetNewParamsConfigViewType) IsKnown() bool
type PresetNewParamsPermissions ¶
type PresetNewParamsPermissions struct {
// Whether this participant can accept waiting requests
AcceptWaitingRequests param.Field[bool] `json:"accept_waiting_requests" api:"required"`
CanAcceptProductionRequests param.Field[bool] `json:"can_accept_production_requests" api:"required"`
CanChangeParticipantPermissions param.Field[bool] `json:"can_change_participant_permissions" api:"required"`
CanEditDisplayName param.Field[bool] `json:"can_edit_display_name" api:"required"`
CanLivestream param.Field[bool] `json:"can_livestream" api:"required"`
CanRecord param.Field[bool] `json:"can_record" api:"required"`
CanSpotlight param.Field[bool] `json:"can_spotlight" api:"required"`
// Chat permissions
Chat param.Field[PresetNewParamsPermissionsChat] `json:"chat" api:"required"`
ConnectedMeetings param.Field[PresetNewParamsPermissionsConnectedMeetings] `json:"connected_meetings" api:"required"`
DisableParticipantAudio param.Field[bool] `json:"disable_participant_audio" api:"required"`
DisableParticipantScreensharing param.Field[bool] `json:"disable_participant_screensharing" api:"required"`
DisableParticipantVideo param.Field[bool] `json:"disable_participant_video" api:"required"`
// Whether this participant is visible to others or not
HiddenParticipant param.Field[bool] `json:"hidden_participant" api:"required"`
KickParticipant param.Field[bool] `json:"kick_participant" api:"required"`
// Media permissions
Media param.Field[PresetNewParamsPermissionsMedia] `json:"media" api:"required"`
PinParticipant param.Field[bool] `json:"pin_participant" api:"required"`
// Plugin permissions
Plugins param.Field[PresetNewParamsPermissionsPlugins] `json:"plugins" api:"required"`
// Poll permissions
Polls param.Field[PresetNewParamsPermissionsPolls] `json:"polls" api:"required"`
// Type of the recording peer
RecorderType param.Field[PresetNewParamsPermissionsRecorderType] `json:"recorder_type" api:"required"`
ShowParticipantList param.Field[bool] `json:"show_participant_list" api:"required"`
// Waiting room type
WaitingRoomType param.Field[PresetNewParamsPermissionsWaitingRoomType] `json:"waiting_room_type" api:"required"`
IsRecorder param.Field[bool] `json:"is_recorder"`
}
func (PresetNewParamsPermissions) MarshalJSON ¶
func (r PresetNewParamsPermissions) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsChat ¶
type PresetNewParamsPermissionsChat struct {
Private param.Field[PresetNewParamsPermissionsChatPrivate] `json:"private" api:"required"`
Public param.Field[PresetNewParamsPermissionsChatPublic] `json:"public" api:"required"`
}
Chat permissions
func (PresetNewParamsPermissionsChat) MarshalJSON ¶
func (r PresetNewParamsPermissionsChat) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsChatPrivate ¶
type PresetNewParamsPermissionsChatPrivate struct {
CanReceive param.Field[bool] `json:"can_receive" api:"required"`
CanSend param.Field[bool] `json:"can_send" api:"required"`
Files param.Field[bool] `json:"files" api:"required"`
Text param.Field[bool] `json:"text" api:"required"`
}
func (PresetNewParamsPermissionsChatPrivate) MarshalJSON ¶
func (r PresetNewParamsPermissionsChatPrivate) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsChatPublic ¶
type PresetNewParamsPermissionsChatPublic struct {
// Can send messages in general
CanSend param.Field[bool] `json:"can_send" api:"required"`
// Can send file messages
Files param.Field[bool] `json:"files" api:"required"`
// Can send text messages
Text param.Field[bool] `json:"text" api:"required"`
}
func (PresetNewParamsPermissionsChatPublic) MarshalJSON ¶
func (r PresetNewParamsPermissionsChatPublic) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsConnectedMeetings ¶
type PresetNewParamsPermissionsConnectedMeetings struct {
CanAlterConnectedMeetings param.Field[bool] `json:"can_alter_connected_meetings" api:"required"`
CanSwitchConnectedMeetings param.Field[bool] `json:"can_switch_connected_meetings" api:"required"`
CanSwitchToParentMeeting param.Field[bool] `json:"can_switch_to_parent_meeting" api:"required"`
}
func (PresetNewParamsPermissionsConnectedMeetings) MarshalJSON ¶
func (r PresetNewParamsPermissionsConnectedMeetings) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsMedia ¶
type PresetNewParamsPermissionsMedia struct {
// Audio permissions
Audio param.Field[PresetNewParamsPermissionsMediaAudio] `json:"audio" api:"required"`
Screenshare param.Field[PresetNewParamsPermissionsMediaScreenshare] `json:"screenshare" api:"required"`
// Video permissions
Video param.Field[PresetNewParamsPermissionsMediaVideo] `json:"video" api:"required"`
}
Media permissions
func (PresetNewParamsPermissionsMedia) MarshalJSON ¶
func (r PresetNewParamsPermissionsMedia) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsMediaAudio ¶
type PresetNewParamsPermissionsMediaAudio struct {
// Can produce audio
CanProduce param.Field[PresetNewParamsPermissionsMediaAudioCanProduce] `json:"can_produce" api:"required"`
}
Audio permissions
func (PresetNewParamsPermissionsMediaAudio) MarshalJSON ¶
func (r PresetNewParamsPermissionsMediaAudio) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsMediaAudioCanProduce ¶
type PresetNewParamsPermissionsMediaAudioCanProduce string
Can produce audio
const ( PresetNewParamsPermissionsMediaAudioCanProduceAllowed PresetNewParamsPermissionsMediaAudioCanProduce = "ALLOWED" PresetNewParamsPermissionsMediaAudioCanProduceNotAllowed PresetNewParamsPermissionsMediaAudioCanProduce = "NOT_ALLOWED" PresetNewParamsPermissionsMediaAudioCanProduceCanRequest PresetNewParamsPermissionsMediaAudioCanProduce = "CAN_REQUEST" )
func (PresetNewParamsPermissionsMediaAudioCanProduce) IsKnown ¶
func (r PresetNewParamsPermissionsMediaAudioCanProduce) IsKnown() bool
type PresetNewParamsPermissionsMediaScreenshare ¶
type PresetNewParamsPermissionsMediaScreenshare struct {
CanProduce param.Field[PresetNewParamsPermissionsMediaScreenshareCanProduce] `json:"can_produce" api:"required"`
}
Screenshare permissions
func (PresetNewParamsPermissionsMediaScreenshare) MarshalJSON ¶
func (r PresetNewParamsPermissionsMediaScreenshare) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsMediaScreenshareCanProduce ¶
type PresetNewParamsPermissionsMediaScreenshareCanProduce string
Can produce screen share video
const ( )
func (PresetNewParamsPermissionsMediaScreenshareCanProduce) IsKnown ¶
func (r PresetNewParamsPermissionsMediaScreenshareCanProduce) IsKnown() bool
type PresetNewParamsPermissionsMediaVideo ¶
type PresetNewParamsPermissionsMediaVideo struct {
// Can produce video
CanProduce param.Field[PresetNewParamsPermissionsMediaVideoCanProduce] `json:"can_produce" api:"required"`
}
Video permissions
func (PresetNewParamsPermissionsMediaVideo) MarshalJSON ¶
func (r PresetNewParamsPermissionsMediaVideo) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsMediaVideoCanProduce ¶
type PresetNewParamsPermissionsMediaVideoCanProduce string
Can produce video
const ( PresetNewParamsPermissionsMediaVideoCanProduceAllowed PresetNewParamsPermissionsMediaVideoCanProduce = "ALLOWED" PresetNewParamsPermissionsMediaVideoCanProduceNotAllowed PresetNewParamsPermissionsMediaVideoCanProduce = "NOT_ALLOWED" PresetNewParamsPermissionsMediaVideoCanProduceCanRequest PresetNewParamsPermissionsMediaVideoCanProduce = "CAN_REQUEST" )
func (PresetNewParamsPermissionsMediaVideoCanProduce) IsKnown ¶
func (r PresetNewParamsPermissionsMediaVideoCanProduce) IsKnown() bool
type PresetNewParamsPermissionsPlugins ¶
type PresetNewParamsPermissionsPlugins struct {
// Can close plugins that are already open
CanClose param.Field[bool] `json:"can_close" api:"required"`
// Can edit plugin config
CanEditConfig param.Field[bool] `json:"can_edit_config" api:"required"`
// Can start plugins
CanStart param.Field[bool] `json:"can_start" api:"required"`
Config param.Field[PresetNewParamsPermissionsPluginsConfigUnion] `json:"config" api:"required" format:"uuid"`
}
Plugin permissions
func (PresetNewParamsPermissionsPlugins) MarshalJSON ¶
func (r PresetNewParamsPermissionsPlugins) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsPluginsConfigObject ¶
type PresetNewParamsPermissionsPluginsConfigObject struct {
AccessControl param.Field[PresetNewParamsPermissionsPluginsConfigObjectAccessControl] `json:"access_control" api:"required"`
HandlesViewOnly param.Field[bool] `json:"handles_view_only" api:"required"`
}
func (PresetNewParamsPermissionsPluginsConfigObject) ImplementsPresetNewParamsPermissionsPluginsConfigUnion ¶
func (r PresetNewParamsPermissionsPluginsConfigObject) ImplementsPresetNewParamsPermissionsPluginsConfigUnion()
func (PresetNewParamsPermissionsPluginsConfigObject) MarshalJSON ¶
func (r PresetNewParamsPermissionsPluginsConfigObject) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsPluginsConfigObjectAccessControl ¶
type PresetNewParamsPermissionsPluginsConfigObjectAccessControl string
const ( PresetNewParamsPermissionsPluginsConfigObjectAccessControlFullAccess PresetNewParamsPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS" PresetNewParamsPermissionsPluginsConfigObjectAccessControlViewOnly PresetNewParamsPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY" )
func (PresetNewParamsPermissionsPluginsConfigObjectAccessControl) IsKnown ¶
func (r PresetNewParamsPermissionsPluginsConfigObjectAccessControl) IsKnown() bool
type PresetNewParamsPermissionsPluginsConfigUnion ¶
type PresetNewParamsPermissionsPluginsConfigUnion interface {
ImplementsPresetNewParamsPermissionsPluginsConfigUnion()
}
Satisfied by shared.UnionString, realtime_kit.PresetNewParamsPermissionsPluginsConfigObject.
type PresetNewParamsPermissionsPolls ¶
type PresetNewParamsPermissionsPolls struct {
// Can create polls
CanCreate param.Field[bool] `json:"can_create" api:"required"`
// Can view polls
CanView param.Field[bool] `json:"can_view" api:"required"`
// Can vote on polls
CanVote param.Field[bool] `json:"can_vote" api:"required"`
}
Poll permissions
func (PresetNewParamsPermissionsPolls) MarshalJSON ¶
func (r PresetNewParamsPermissionsPolls) MarshalJSON() (data []byte, err error)
type PresetNewParamsPermissionsRecorderType ¶
type PresetNewParamsPermissionsRecorderType string
Type of the recording peer
const ( PresetNewParamsPermissionsRecorderTypeRecorder PresetNewParamsPermissionsRecorderType = "RECORDER" PresetNewParamsPermissionsRecorderTypeLivestreamer PresetNewParamsPermissionsRecorderType = "LIVESTREAMER" PresetNewParamsPermissionsRecorderTypeNone PresetNewParamsPermissionsRecorderType = "NONE" )
func (PresetNewParamsPermissionsRecorderType) IsKnown ¶
func (r PresetNewParamsPermissionsRecorderType) IsKnown() bool
type PresetNewParamsPermissionsWaitingRoomType ¶
type PresetNewParamsPermissionsWaitingRoomType string
Waiting room type
const ( PresetNewParamsPermissionsWaitingRoomTypeSkip PresetNewParamsPermissionsWaitingRoomType = "SKIP" PresetNewParamsPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetNewParamsPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY" PresetNewParamsPermissionsWaitingRoomTypeSkipOnAccept PresetNewParamsPermissionsWaitingRoomType = "SKIP_ON_ACCEPT" )
func (PresetNewParamsPermissionsWaitingRoomType) IsKnown ¶
func (r PresetNewParamsPermissionsWaitingRoomType) IsKnown() bool
type PresetNewParamsUI ¶
type PresetNewParamsUI struct {
DesignTokens param.Field[PresetNewParamsUIDesignTokens] `json:"design_tokens" api:"required"`
ConfigDiff param.Field[interface{}] `json:"config_diff"`
}
func (PresetNewParamsUI) MarshalJSON ¶
func (r PresetNewParamsUI) MarshalJSON() (data []byte, err error)
type PresetNewParamsUIDesignTokens ¶
type PresetNewParamsUIDesignTokens struct {
BorderRadius param.Field[PresetNewParamsUIDesignTokensBorderRadius] `json:"border_radius" api:"required"`
BorderWidth param.Field[PresetNewParamsUIDesignTokensBorderWidth] `json:"border_width" api:"required"`
Colors param.Field[PresetNewParamsUIDesignTokensColors] `json:"colors" api:"required"`
Logo param.Field[string] `json:"logo" api:"required"`
SpacingBase param.Field[float64] `json:"spacing_base" api:"required"`
Theme param.Field[PresetNewParamsUIDesignTokensTheme] `json:"theme" api:"required"`
}
func (PresetNewParamsUIDesignTokens) MarshalJSON ¶
func (r PresetNewParamsUIDesignTokens) MarshalJSON() (data []byte, err error)
type PresetNewParamsUIDesignTokensBorderRadius ¶
type PresetNewParamsUIDesignTokensBorderRadius string
const (
PresetNewParamsUIDesignTokensBorderRadiusRounded PresetNewParamsUIDesignTokensBorderRadius = "rounded"
)
func (PresetNewParamsUIDesignTokensBorderRadius) IsKnown ¶
func (r PresetNewParamsUIDesignTokensBorderRadius) IsKnown() bool
type PresetNewParamsUIDesignTokensBorderWidth ¶
type PresetNewParamsUIDesignTokensBorderWidth string
const (
PresetNewParamsUIDesignTokensBorderWidthThin PresetNewParamsUIDesignTokensBorderWidth = "thin"
)
func (PresetNewParamsUIDesignTokensBorderWidth) IsKnown ¶
func (r PresetNewParamsUIDesignTokensBorderWidth) IsKnown() bool
type PresetNewParamsUIDesignTokensColors ¶
type PresetNewParamsUIDesignTokensColors struct {
Background param.Field[PresetNewParamsUIDesignTokensColorsBackground] `json:"background" api:"required"`
Brand param.Field[PresetNewParamsUIDesignTokensColorsBrand] `json:"brand" api:"required"`
Danger param.Field[string] `json:"danger" api:"required"`
Success param.Field[string] `json:"success" api:"required"`
Text param.Field[string] `json:"text" api:"required"`
TextOnBrand param.Field[string] `json:"text_on_brand" api:"required"`
VideoBg param.Field[string] `json:"video_bg" api:"required"`
Warning param.Field[string] `json:"warning" api:"required"`
}
func (PresetNewParamsUIDesignTokensColors) MarshalJSON ¶
func (r PresetNewParamsUIDesignTokensColors) MarshalJSON() (data []byte, err error)
type PresetNewParamsUIDesignTokensColorsBackground ¶
type PresetNewParamsUIDesignTokensColorsBackground struct {
Number1000 param.Field[string] `json:"1000" api:"required"`
Number600 param.Field[string] `json:"600" api:"required"`
Number700 param.Field[string] `json:"700" api:"required"`
Number800 param.Field[string] `json:"800" api:"required"`
Number900 param.Field[string] `json:"900" api:"required"`
}
func (PresetNewParamsUIDesignTokensColorsBackground) MarshalJSON ¶
func (r PresetNewParamsUIDesignTokensColorsBackground) MarshalJSON() (data []byte, err error)
type PresetNewParamsUIDesignTokensColorsBrand ¶
type PresetNewParamsUIDesignTokensColorsBrand struct {
Number300 param.Field[string] `json:"300" api:"required"`
Number400 param.Field[string] `json:"400" api:"required"`
Number500 param.Field[string] `json:"500" api:"required"`
Number600 param.Field[string] `json:"600" api:"required"`
Number700 param.Field[string] `json:"700" api:"required"`
}
func (PresetNewParamsUIDesignTokensColorsBrand) MarshalJSON ¶
func (r PresetNewParamsUIDesignTokensColorsBrand) MarshalJSON() (data []byte, err error)
type PresetNewParamsUIDesignTokensTheme ¶
type PresetNewParamsUIDesignTokensTheme string
const (
PresetNewParamsUIDesignTokensThemeDark PresetNewParamsUIDesignTokensTheme = "dark"
)
func (PresetNewParamsUIDesignTokensTheme) IsKnown ¶
func (r PresetNewParamsUIDesignTokensTheme) IsKnown() bool
type PresetNewResponse ¶
type PresetNewResponse struct {
// Data returned by the operation
Data PresetNewResponseData `json:"data" api:"required"`
// Success status of the operation
Success bool `json:"success" api:"required"`
JSON presetNewResponseJSON `json:"-"`
}
func (*PresetNewResponse) UnmarshalJSON ¶
func (r *PresetNewResponse) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseData ¶
type PresetNewResponseData struct {
// ID of the preset
ID string `json:"id" api:"required" format:"uuid"`
Config PresetNewResponseDataConfig `json:"config" api:"required"`
// Name of the preset
Name string `json:"name" api:"required"`
UI PresetNewResponseDataUI `json:"ui" api:"required"`
Permissions PresetNewResponseDataPermissions `json:"permissions"`
JSON presetNewResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*PresetNewResponseData) UnmarshalJSON ¶
func (r *PresetNewResponseData) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataConfig ¶
type PresetNewResponseDataConfig struct {
MaxScreenshareCount int64 `json:"max_screenshare_count" api:"required"`
// Maximum number of streams that are visible on a device
MaxVideoStreams PresetNewResponseDataConfigMaxVideoStreams `json:"max_video_streams" api:"required"`
// Media configuration options. eg: Video quality
Media PresetNewResponseDataConfigMedia `json:"media" api:"required"`
// Type of the meeting
ViewType PresetNewResponseDataConfigViewType `json:"view_type" api:"required"`
JSON presetNewResponseDataConfigJSON `json:"-"`
}
func (*PresetNewResponseDataConfig) UnmarshalJSON ¶
func (r *PresetNewResponseDataConfig) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataConfigMaxVideoStreams ¶
type PresetNewResponseDataConfigMaxVideoStreams struct {
// Maximum number of video streams visible on desktop devices
Desktop int64 `json:"desktop" api:"required"`
// Maximum number of streams visible on mobile devices
Mobile int64 `json:"mobile" api:"required"`
JSON presetNewResponseDataConfigMaxVideoStreamsJSON `json:"-"`
}
Maximum number of streams that are visible on a device
func (*PresetNewResponseDataConfigMaxVideoStreams) UnmarshalJSON ¶
func (r *PresetNewResponseDataConfigMaxVideoStreams) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataConfigMedia ¶
type PresetNewResponseDataConfigMedia struct {
Screenshare PresetNewResponseDataConfigMediaScreenshare `json:"screenshare" api:"required"`
// Configuration options for participant videos
Video PresetNewResponseDataConfigMediaVideo `json:"video" api:"required"`
// Control options for Audio quality.
Audio PresetNewResponseDataConfigMediaAudio `json:"audio"`
JSON presetNewResponseDataConfigMediaJSON `json:"-"`
}
Media configuration options. eg: Video quality
func (*PresetNewResponseDataConfigMedia) UnmarshalJSON ¶
func (r *PresetNewResponseDataConfigMedia) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataConfigMediaAudio ¶
type PresetNewResponseDataConfigMediaAudio struct {
// Enable High Quality Audio for your meetings
EnableHighBitrate bool `json:"enable_high_bitrate"`
// Enable Stereo for your meetings
EnableStereo bool `json:"enable_stereo"`
JSON presetNewResponseDataConfigMediaAudioJSON `json:"-"`
}
Control options for Audio quality.
func (*PresetNewResponseDataConfigMediaAudio) UnmarshalJSON ¶
func (r *PresetNewResponseDataConfigMediaAudio) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataConfigMediaScreenshare ¶
type PresetNewResponseDataConfigMediaScreenshare struct {
FrameRate int64 `json:"frame_rate" api:"required"`
// Quality of screen share
}
Configuration options for participant screen shares
func (*PresetNewResponseDataConfigMediaScreenshare) UnmarshalJSON ¶
func (r *PresetNewResponseDataConfigMediaScreenshare) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataConfigMediaScreenshareQuality ¶
type PresetNewResponseDataConfigMediaScreenshareQuality string
Quality of screen share
const ( )
func (PresetNewResponseDataConfigMediaScreenshareQuality) IsKnown ¶
func (r PresetNewResponseDataConfigMediaScreenshareQuality) IsKnown() bool
type PresetNewResponseDataConfigMediaVideo ¶
type PresetNewResponseDataConfigMediaVideo struct {
// Frame rate of participants' video
FrameRate int64 `json:"frame_rate" api:"required"`
// Video quality of participants
Quality PresetNewResponseDataConfigMediaVideoQuality `json:"quality" api:"required"`
JSON presetNewResponseDataConfigMediaVideoJSON `json:"-"`
}
Configuration options for participant videos
func (*PresetNewResponseDataConfigMediaVideo) UnmarshalJSON ¶
func (r *PresetNewResponseDataConfigMediaVideo) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataConfigMediaVideoQuality ¶
type PresetNewResponseDataConfigMediaVideoQuality string
Video quality of participants
const ( PresetNewResponseDataConfigMediaVideoQualityHD PresetNewResponseDataConfigMediaVideoQuality = "hd" PresetNewResponseDataConfigMediaVideoQualityVga PresetNewResponseDataConfigMediaVideoQuality = "vga" PresetNewResponseDataConfigMediaVideoQualityQvga PresetNewResponseDataConfigMediaVideoQuality = "qvga" )
func (PresetNewResponseDataConfigMediaVideoQuality) IsKnown ¶
func (r PresetNewResponseDataConfigMediaVideoQuality) IsKnown() bool
type PresetNewResponseDataConfigViewType ¶
type PresetNewResponseDataConfigViewType string
Type of the meeting
const ( PresetNewResponseDataConfigViewTypeGroupCall PresetNewResponseDataConfigViewType = "GROUP_CALL" PresetNewResponseDataConfigViewTypeWebinar PresetNewResponseDataConfigViewType = "WEBINAR" PresetNewResponseDataConfigViewTypeAudioRoom PresetNewResponseDataConfigViewType = "AUDIO_ROOM" )
func (PresetNewResponseDataConfigViewType) IsKnown ¶
func (r PresetNewResponseDataConfigViewType) IsKnown() bool
type PresetNewResponseDataPermissions ¶
type PresetNewResponseDataPermissions struct {
// Whether this participant can accept waiting requests
AcceptWaitingRequests bool `json:"accept_waiting_requests" api:"required"`
CanAcceptProductionRequests bool `json:"can_accept_production_requests" api:"required"`
CanChangeParticipantPermissions bool `json:"can_change_participant_permissions" api:"required"`
CanEditDisplayName bool `json:"can_edit_display_name" api:"required"`
CanLivestream bool `json:"can_livestream" api:"required"`
CanRecord bool `json:"can_record" api:"required"`
CanSpotlight bool `json:"can_spotlight" api:"required"`
// Chat permissions
Chat PresetNewResponseDataPermissionsChat `json:"chat" api:"required"`
ConnectedMeetings PresetNewResponseDataPermissionsConnectedMeetings `json:"connected_meetings" api:"required"`
DisableParticipantAudio bool `json:"disable_participant_audio" api:"required"`
DisableParticipantScreensharing bool `json:"disable_participant_screensharing" api:"required"`
DisableParticipantVideo bool `json:"disable_participant_video" api:"required"`
// Whether this participant is visible to others or not
HiddenParticipant bool `json:"hidden_participant" api:"required"`
KickParticipant bool `json:"kick_participant" api:"required"`
// Media permissions
Media PresetNewResponseDataPermissionsMedia `json:"media" api:"required"`
PinParticipant bool `json:"pin_participant" api:"required"`
// Plugin permissions
Plugins PresetNewResponseDataPermissionsPlugins `json:"plugins" api:"required"`
// Poll permissions
Polls PresetNewResponseDataPermissionsPolls `json:"polls" api:"required"`
// Type of the recording peer
RecorderType PresetNewResponseDataPermissionsRecorderType `json:"recorder_type" api:"required"`
ShowParticipantList bool `json:"show_participant_list" api:"required"`
// Waiting room type
WaitingRoomType PresetNewResponseDataPermissionsWaitingRoomType `json:"waiting_room_type" api:"required"`
IsRecorder bool `json:"is_recorder"`
JSON presetNewResponseDataPermissionsJSON `json:"-"`
}
func (*PresetNewResponseDataPermissions) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissions) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsChat ¶
type PresetNewResponseDataPermissionsChat struct {
Private PresetNewResponseDataPermissionsChatPrivate `json:"private" api:"required"`
Public PresetNewResponseDataPermissionsChatPublic `json:"public" api:"required"`
JSON presetNewResponseDataPermissionsChatJSON `json:"-"`
}
Chat permissions
func (*PresetNewResponseDataPermissionsChat) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsChat) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsChatPrivate ¶
type PresetNewResponseDataPermissionsChatPrivate struct {
CanReceive bool `json:"can_receive" api:"required"`
CanSend bool `json:"can_send" api:"required"`
Files bool `json:"files" api:"required"`
Text bool `json:"text" api:"required"`
JSON presetNewResponseDataPermissionsChatPrivateJSON `json:"-"`
}
func (*PresetNewResponseDataPermissionsChatPrivate) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsChatPrivate) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsChatPublic ¶
type PresetNewResponseDataPermissionsChatPublic struct {
// Can send messages in general
CanSend bool `json:"can_send" api:"required"`
// Can send file messages
Files bool `json:"files" api:"required"`
// Can send text messages
Text bool `json:"text" api:"required"`
JSON presetNewResponseDataPermissionsChatPublicJSON `json:"-"`
}
func (*PresetNewResponseDataPermissionsChatPublic) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsChatPublic) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsConnectedMeetings ¶
type PresetNewResponseDataPermissionsConnectedMeetings struct {
CanAlterConnectedMeetings bool `json:"can_alter_connected_meetings" api:"required"`
CanSwitchConnectedMeetings bool `json:"can_switch_connected_meetings" api:"required"`
CanSwitchToParentMeeting bool `json:"can_switch_to_parent_meeting" api:"required"`
JSON presetNewResponseDataPermissionsConnectedMeetingsJSON `json:"-"`
}
func (*PresetNewResponseDataPermissionsConnectedMeetings) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsConnectedMeetings) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsMedia ¶
type PresetNewResponseDataPermissionsMedia struct {
// Audio permissions
Audio PresetNewResponseDataPermissionsMediaAudio `json:"audio" api:"required"`
Screenshare PresetNewResponseDataPermissionsMediaScreenshare `json:"screenshare" api:"required"`
// Video permissions
Video PresetNewResponseDataPermissionsMediaVideo `json:"video" api:"required"`
JSON presetNewResponseDataPermissionsMediaJSON `json:"-"`
}
Media permissions
func (*PresetNewResponseDataPermissionsMedia) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsMedia) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsMediaAudio ¶
type PresetNewResponseDataPermissionsMediaAudio struct {
// Can produce audio
CanProduce PresetNewResponseDataPermissionsMediaAudioCanProduce `json:"can_produce" api:"required"`
JSON presetNewResponseDataPermissionsMediaAudioJSON `json:"-"`
}
Audio permissions
func (*PresetNewResponseDataPermissionsMediaAudio) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsMediaAudio) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsMediaAudioCanProduce ¶
type PresetNewResponseDataPermissionsMediaAudioCanProduce string
Can produce audio
const ( PresetNewResponseDataPermissionsMediaAudioCanProduceAllowed PresetNewResponseDataPermissionsMediaAudioCanProduce = "ALLOWED" PresetNewResponseDataPermissionsMediaAudioCanProduceNotAllowed PresetNewResponseDataPermissionsMediaAudioCanProduce = "NOT_ALLOWED" PresetNewResponseDataPermissionsMediaAudioCanProduceCanRequest PresetNewResponseDataPermissionsMediaAudioCanProduce = "CAN_REQUEST" )
func (PresetNewResponseDataPermissionsMediaAudioCanProduce) IsKnown ¶
func (r PresetNewResponseDataPermissionsMediaAudioCanProduce) IsKnown() bool
type PresetNewResponseDataPermissionsMediaScreenshare ¶
type PresetNewResponseDataPermissionsMediaScreenshare struct {
// Can produce screen share video
}
Screenshare permissions
func (*PresetNewResponseDataPermissionsMediaScreenshare) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsMediaScreenshare) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsMediaScreenshareCanProduce ¶
type PresetNewResponseDataPermissionsMediaScreenshareCanProduce string
Can produce screen share video
const ( )
func (PresetNewResponseDataPermissionsMediaScreenshareCanProduce) IsKnown ¶
func (r PresetNewResponseDataPermissionsMediaScreenshareCanProduce) IsKnown() bool
type PresetNewResponseDataPermissionsMediaVideo ¶
type PresetNewResponseDataPermissionsMediaVideo struct {
// Can produce video
CanProduce PresetNewResponseDataPermissionsMediaVideoCanProduce `json:"can_produce" api:"required"`
JSON presetNewResponseDataPermissionsMediaVideoJSON `json:"-"`
}
Video permissions
func (*PresetNewResponseDataPermissionsMediaVideo) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsMediaVideo) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsMediaVideoCanProduce ¶
type PresetNewResponseDataPermissionsMediaVideoCanProduce string
Can produce video
const ( PresetNewResponseDataPermissionsMediaVideoCanProduceAllowed PresetNewResponseDataPermissionsMediaVideoCanProduce = "ALLOWED" PresetNewResponseDataPermissionsMediaVideoCanProduceNotAllowed PresetNewResponseDataPermissionsMediaVideoCanProduce = "NOT_ALLOWED" PresetNewResponseDataPermissionsMediaVideoCanProduceCanRequest PresetNewResponseDataPermissionsMediaVideoCanProduce = "CAN_REQUEST" )
func (PresetNewResponseDataPermissionsMediaVideoCanProduce) IsKnown ¶
func (r PresetNewResponseDataPermissionsMediaVideoCanProduce) IsKnown() bool
type PresetNewResponseDataPermissionsPlugins ¶
type PresetNewResponseDataPermissionsPlugins struct {
// Can close plugins that are already open
CanClose bool `json:"can_close" api:"required"`
// Can edit plugin config
CanEditConfig bool `json:"can_edit_config" api:"required"`
// Can start plugins
CanStart bool `json:"can_start" api:"required"`
Config PresetNewResponseDataPermissionsPluginsConfigUnion `json:"config" api:"required" format:"uuid"`
JSON presetNewResponseDataPermissionsPluginsJSON `json:"-"`
}
Plugin permissions
func (*PresetNewResponseDataPermissionsPlugins) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsPlugins) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsPluginsConfigObject ¶
type PresetNewResponseDataPermissionsPluginsConfigObject struct {
AccessControl PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl `json:"access_control" api:"required"`
HandlesViewOnly bool `json:"handles_view_only" api:"required"`
JSON presetNewResponseDataPermissionsPluginsConfigObjectJSON `json:"-"`
}
func (PresetNewResponseDataPermissionsPluginsConfigObject) ImplementsPresetNewResponseDataPermissionsPluginsConfigUnion ¶
func (r PresetNewResponseDataPermissionsPluginsConfigObject) ImplementsPresetNewResponseDataPermissionsPluginsConfigUnion()
func (*PresetNewResponseDataPermissionsPluginsConfigObject) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsPluginsConfigObject) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl ¶
type PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl string
const ( PresetNewResponseDataPermissionsPluginsConfigObjectAccessControlFullAccess PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS" PresetNewResponseDataPermissionsPluginsConfigObjectAccessControlViewOnly PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY" )
func (PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown ¶
func (r PresetNewResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown() bool
type PresetNewResponseDataPermissionsPluginsConfigUnion ¶
type PresetNewResponseDataPermissionsPluginsConfigUnion interface {
ImplementsPresetNewResponseDataPermissionsPluginsConfigUnion()
}
Union satisfied by shared.UnionString or PresetNewResponseDataPermissionsPluginsConfigObject.
type PresetNewResponseDataPermissionsPolls ¶
type PresetNewResponseDataPermissionsPolls struct {
// Can create polls
CanCreate bool `json:"can_create" api:"required"`
// Can view polls
CanView bool `json:"can_view" api:"required"`
// Can vote on polls
CanVote bool `json:"can_vote" api:"required"`
JSON presetNewResponseDataPermissionsPollsJSON `json:"-"`
}
Poll permissions
func (*PresetNewResponseDataPermissionsPolls) UnmarshalJSON ¶
func (r *PresetNewResponseDataPermissionsPolls) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataPermissionsRecorderType ¶
type PresetNewResponseDataPermissionsRecorderType string
Type of the recording peer
const ( PresetNewResponseDataPermissionsRecorderTypeRecorder PresetNewResponseDataPermissionsRecorderType = "RECORDER" PresetNewResponseDataPermissionsRecorderTypeLivestreamer PresetNewResponseDataPermissionsRecorderType = "LIVESTREAMER" PresetNewResponseDataPermissionsRecorderTypeNone PresetNewResponseDataPermissionsRecorderType = "NONE" )
func (PresetNewResponseDataPermissionsRecorderType) IsKnown ¶
func (r PresetNewResponseDataPermissionsRecorderType) IsKnown() bool
type PresetNewResponseDataPermissionsWaitingRoomType ¶
type PresetNewResponseDataPermissionsWaitingRoomType string
Waiting room type
const ( PresetNewResponseDataPermissionsWaitingRoomTypeSkip PresetNewResponseDataPermissionsWaitingRoomType = "SKIP" PresetNewResponseDataPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetNewResponseDataPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY" PresetNewResponseDataPermissionsWaitingRoomTypeSkipOnAccept PresetNewResponseDataPermissionsWaitingRoomType = "SKIP_ON_ACCEPT" )
func (PresetNewResponseDataPermissionsWaitingRoomType) IsKnown ¶
func (r PresetNewResponseDataPermissionsWaitingRoomType) IsKnown() bool
type PresetNewResponseDataUI ¶
type PresetNewResponseDataUI struct {
DesignTokens PresetNewResponseDataUIDesignTokens `json:"design_tokens" api:"required"`
ConfigDiff interface{} `json:"config_diff"`
JSON presetNewResponseDataUIJSON `json:"-"`
}
func (*PresetNewResponseDataUI) UnmarshalJSON ¶
func (r *PresetNewResponseDataUI) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataUIDesignTokens ¶
type PresetNewResponseDataUIDesignTokens struct {
BorderRadius PresetNewResponseDataUIDesignTokensBorderRadius `json:"border_radius" api:"required"`
BorderWidth PresetNewResponseDataUIDesignTokensBorderWidth `json:"border_width" api:"required"`
Colors PresetNewResponseDataUIDesignTokensColors `json:"colors" api:"required"`
Logo string `json:"logo" api:"required"`
SpacingBase float64 `json:"spacing_base" api:"required"`
Theme PresetNewResponseDataUIDesignTokensTheme `json:"theme" api:"required"`
JSON presetNewResponseDataUIDesignTokensJSON `json:"-"`
}
func (*PresetNewResponseDataUIDesignTokens) UnmarshalJSON ¶
func (r *PresetNewResponseDataUIDesignTokens) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataUIDesignTokensBorderRadius ¶
type PresetNewResponseDataUIDesignTokensBorderRadius string
const (
PresetNewResponseDataUIDesignTokensBorderRadiusRounded PresetNewResponseDataUIDesignTokensBorderRadius = "rounded"
)
func (PresetNewResponseDataUIDesignTokensBorderRadius) IsKnown ¶
func (r PresetNewResponseDataUIDesignTokensBorderRadius) IsKnown() bool
type PresetNewResponseDataUIDesignTokensBorderWidth ¶
type PresetNewResponseDataUIDesignTokensBorderWidth string
const (
PresetNewResponseDataUIDesignTokensBorderWidthThin PresetNewResponseDataUIDesignTokensBorderWidth = "thin"
)
func (PresetNewResponseDataUIDesignTokensBorderWidth) IsKnown ¶
func (r PresetNewResponseDataUIDesignTokensBorderWidth) IsKnown() bool
type PresetNewResponseDataUIDesignTokensColors ¶
type PresetNewResponseDataUIDesignTokensColors struct {
Background PresetNewResponseDataUIDesignTokensColorsBackground `json:"background" api:"required"`
Brand PresetNewResponseDataUIDesignTokensColorsBrand `json:"brand" api:"required"`
Danger string `json:"danger" api:"required"`
Success string `json:"success" api:"required"`
Text string `json:"text" api:"required"`
TextOnBrand string `json:"text_on_brand" api:"required"`
VideoBg string `json:"video_bg" api:"required"`
Warning string `json:"warning" api:"required"`
JSON presetNewResponseDataUIDesignTokensColorsJSON `json:"-"`
}
func (*PresetNewResponseDataUIDesignTokensColors) UnmarshalJSON ¶
func (r *PresetNewResponseDataUIDesignTokensColors) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataUIDesignTokensColorsBackground ¶
type PresetNewResponseDataUIDesignTokensColorsBackground struct {
Number1000 string `json:"1000" api:"required"`
Number600 string `json:"600" api:"required"`
Number700 string `json:"700" api:"required"`
Number800 string `json:"800" api:"required"`
Number900 string `json:"900" api:"required"`
JSON presetNewResponseDataUIDesignTokensColorsBackgroundJSON `json:"-"`
}
func (*PresetNewResponseDataUIDesignTokensColorsBackground) UnmarshalJSON ¶
func (r *PresetNewResponseDataUIDesignTokensColorsBackground) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataUIDesignTokensColorsBrand ¶
type PresetNewResponseDataUIDesignTokensColorsBrand struct {
Number300 string `json:"300" api:"required"`
Number400 string `json:"400" api:"required"`
Number500 string `json:"500" api:"required"`
Number600 string `json:"600" api:"required"`
Number700 string `json:"700" api:"required"`
JSON presetNewResponseDataUIDesignTokensColorsBrandJSON `json:"-"`
}
func (*PresetNewResponseDataUIDesignTokensColorsBrand) UnmarshalJSON ¶
func (r *PresetNewResponseDataUIDesignTokensColorsBrand) UnmarshalJSON(data []byte) (err error)
type PresetNewResponseDataUIDesignTokensTheme ¶
type PresetNewResponseDataUIDesignTokensTheme string
const (
PresetNewResponseDataUIDesignTokensThemeDark PresetNewResponseDataUIDesignTokensTheme = "dark"
)
func (PresetNewResponseDataUIDesignTokensTheme) IsKnown ¶
func (r PresetNewResponseDataUIDesignTokensTheme) IsKnown() bool
type PresetService ¶
type PresetService struct {
Options []option.RequestOption
}
PresetService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPresetService method instead.
func NewPresetService ¶
func NewPresetService(opts ...option.RequestOption) (r *PresetService)
NewPresetService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*PresetService) Delete ¶
func (r *PresetService) Delete(ctx context.Context, appID string, presetID string, body PresetDeleteParams, opts ...option.RequestOption) (res *PresetDeleteResponse, err error)
Deletes a preset using the provided preset ID
func (*PresetService) Get ¶
func (r *PresetService) Get(ctx context.Context, appID string, params PresetGetParams, opts ...option.RequestOption) (res *PresetGetResponse, err error)
Fetches all the presets belonging to an App.
func (*PresetService) GetPresetByID ¶
func (r *PresetService) GetPresetByID(ctx context.Context, appID string, presetID string, query PresetGetPresetByIDParams, opts ...option.RequestOption) (res *PresetGetPresetByIDResponse, err error)
Fetches details of a preset using the provided preset ID
func (*PresetService) New ¶
func (r *PresetService) New(ctx context.Context, appID string, params PresetNewParams, opts ...option.RequestOption) (res *PresetNewResponse, err error)
Creates a preset belonging to the current App
func (*PresetService) Update ¶
func (r *PresetService) Update(ctx context.Context, appID string, presetID string, params PresetUpdateParams, opts ...option.RequestOption) (res *PresetUpdateResponse, err error)
Update a preset by the provided preset ID
type PresetUpdateParams ¶
type PresetUpdateParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
Config param.Field[PresetUpdateParamsConfig] `json:"config"`
// Name of the preset
Name param.Field[string] `json:"name"`
Permissions param.Field[PresetUpdateParamsPermissions] `json:"permissions"`
UI param.Field[PresetUpdateParamsUI] `json:"ui"`
}
func (PresetUpdateParams) MarshalJSON ¶
func (r PresetUpdateParams) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsConfig ¶
type PresetUpdateParamsConfig struct {
MaxScreenshareCount param.Field[int64] `json:"max_screenshare_count"`
// Maximum number of streams that are visible on a device
MaxVideoStreams param.Field[PresetUpdateParamsConfigMaxVideoStreams] `json:"max_video_streams"`
// Media configuration options. eg: Video quality
Media param.Field[PresetUpdateParamsConfigMedia] `json:"media"`
// Type of the meeting
ViewType param.Field[PresetUpdateParamsConfigViewType] `json:"view_type"`
}
func (PresetUpdateParamsConfig) MarshalJSON ¶
func (r PresetUpdateParamsConfig) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsConfigMaxVideoStreams ¶
type PresetUpdateParamsConfigMaxVideoStreams struct {
// Maximum number of video streams visible on desktop devices
Desktop param.Field[int64] `json:"desktop"`
// Maximum number of streams visible on mobile devices
Mobile param.Field[int64] `json:"mobile"`
}
Maximum number of streams that are visible on a device
func (PresetUpdateParamsConfigMaxVideoStreams) MarshalJSON ¶
func (r PresetUpdateParamsConfigMaxVideoStreams) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsConfigMedia ¶
type PresetUpdateParamsConfigMedia struct {
Screenshare param.Field[PresetUpdateParamsConfigMediaScreenshare] `json:"screenshare"`
// Configuration options for participant videos
Video param.Field[PresetUpdateParamsConfigMediaVideo] `json:"video"`
}
Media configuration options. eg: Video quality
func (PresetUpdateParamsConfigMedia) MarshalJSON ¶
func (r PresetUpdateParamsConfigMedia) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsConfigMediaScreenshare ¶
type PresetUpdateParamsConfigMediaScreenshare struct {
FrameRate param.Field[int64] `json:"frame_rate"`
Quality param.Field[PresetUpdateParamsConfigMediaScreenshareQuality] `json:"quality"`
}
Configuration options for participant screen shares
func (PresetUpdateParamsConfigMediaScreenshare) MarshalJSON ¶
func (r PresetUpdateParamsConfigMediaScreenshare) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsConfigMediaScreenshareQuality ¶
type PresetUpdateParamsConfigMediaScreenshareQuality string
Quality of screen share
const ( )
func (PresetUpdateParamsConfigMediaScreenshareQuality) IsKnown ¶
func (r PresetUpdateParamsConfigMediaScreenshareQuality) IsKnown() bool
type PresetUpdateParamsConfigMediaVideo ¶
type PresetUpdateParamsConfigMediaVideo struct {
// Frame rate of participants' video
FrameRate param.Field[int64] `json:"frame_rate"`
// Video quality of participants
Quality param.Field[PresetUpdateParamsConfigMediaVideoQuality] `json:"quality"`
}
Configuration options for participant videos
func (PresetUpdateParamsConfigMediaVideo) MarshalJSON ¶
func (r PresetUpdateParamsConfigMediaVideo) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsConfigMediaVideoQuality ¶
type PresetUpdateParamsConfigMediaVideoQuality string
Video quality of participants
const ( PresetUpdateParamsConfigMediaVideoQualityHD PresetUpdateParamsConfigMediaVideoQuality = "hd" PresetUpdateParamsConfigMediaVideoQualityVga PresetUpdateParamsConfigMediaVideoQuality = "vga" PresetUpdateParamsConfigMediaVideoQualityQvga PresetUpdateParamsConfigMediaVideoQuality = "qvga" )
func (PresetUpdateParamsConfigMediaVideoQuality) IsKnown ¶
func (r PresetUpdateParamsConfigMediaVideoQuality) IsKnown() bool
type PresetUpdateParamsConfigViewType ¶
type PresetUpdateParamsConfigViewType string
Type of the meeting
const ( PresetUpdateParamsConfigViewTypeGroupCall PresetUpdateParamsConfigViewType = "GROUP_CALL" PresetUpdateParamsConfigViewTypeWebinar PresetUpdateParamsConfigViewType = "WEBINAR" PresetUpdateParamsConfigViewTypeAudioRoom PresetUpdateParamsConfigViewType = "AUDIO_ROOM" )
func (PresetUpdateParamsConfigViewType) IsKnown ¶
func (r PresetUpdateParamsConfigViewType) IsKnown() bool
type PresetUpdateParamsPermissions ¶
type PresetUpdateParamsPermissions struct {
// Whether this participant can accept waiting requests
AcceptWaitingRequests param.Field[bool] `json:"accept_waiting_requests"`
CanAcceptProductionRequests param.Field[bool] `json:"can_accept_production_requests"`
CanChangeParticipantPermissions param.Field[bool] `json:"can_change_participant_permissions"`
CanEditDisplayName param.Field[bool] `json:"can_edit_display_name"`
CanLivestream param.Field[bool] `json:"can_livestream"`
CanRecord param.Field[bool] `json:"can_record"`
CanSpotlight param.Field[bool] `json:"can_spotlight"`
// Chat permissions
Chat param.Field[PresetUpdateParamsPermissionsChat] `json:"chat"`
ConnectedMeetings param.Field[PresetUpdateParamsPermissionsConnectedMeetings] `json:"connected_meetings"`
DisableParticipantAudio param.Field[bool] `json:"disable_participant_audio"`
DisableParticipantScreensharing param.Field[bool] `json:"disable_participant_screensharing"`
DisableParticipantVideo param.Field[bool] `json:"disable_participant_video"`
// Whether this participant is visible to others or not
HiddenParticipant param.Field[bool] `json:"hidden_participant"`
IsRecorder param.Field[bool] `json:"is_recorder"`
KickParticipant param.Field[bool] `json:"kick_participant"`
// Media permissions
Media param.Field[PresetUpdateParamsPermissionsMedia] `json:"media"`
PinParticipant param.Field[bool] `json:"pin_participant"`
// Plugin permissions
Plugins param.Field[PresetUpdateParamsPermissionsPlugins] `json:"plugins"`
// Poll permissions
Polls param.Field[PresetUpdateParamsPermissionsPolls] `json:"polls"`
// Type of the recording peer
RecorderType param.Field[PresetUpdateParamsPermissionsRecorderType] `json:"recorder_type"`
ShowParticipantList param.Field[bool] `json:"show_participant_list"`
// Waiting room type
WaitingRoomType param.Field[PresetUpdateParamsPermissionsWaitingRoomType] `json:"waiting_room_type"`
}
func (PresetUpdateParamsPermissions) MarshalJSON ¶
func (r PresetUpdateParamsPermissions) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsChat ¶
type PresetUpdateParamsPermissionsChat struct {
Private param.Field[PresetUpdateParamsPermissionsChatPrivate] `json:"private"`
Public param.Field[PresetUpdateParamsPermissionsChatPublic] `json:"public"`
}
Chat permissions
func (PresetUpdateParamsPermissionsChat) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsChat) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsChatPrivate ¶
type PresetUpdateParamsPermissionsChatPrivate struct {
CanReceive param.Field[bool] `json:"can_receive"`
CanSend param.Field[bool] `json:"can_send"`
Files param.Field[bool] `json:"files"`
Text param.Field[bool] `json:"text"`
}
func (PresetUpdateParamsPermissionsChatPrivate) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsChatPrivate) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsChatPublic ¶
type PresetUpdateParamsPermissionsChatPublic struct {
// Can send messages in general
CanSend param.Field[bool] `json:"can_send"`
// Can send file messages
Files param.Field[bool] `json:"files"`
// Can send text messages
Text param.Field[bool] `json:"text"`
}
func (PresetUpdateParamsPermissionsChatPublic) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsChatPublic) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsConnectedMeetings ¶
type PresetUpdateParamsPermissionsConnectedMeetings struct {
CanAlterConnectedMeetings param.Field[bool] `json:"can_alter_connected_meetings"`
CanSwitchConnectedMeetings param.Field[bool] `json:"can_switch_connected_meetings"`
CanSwitchToParentMeeting param.Field[bool] `json:"can_switch_to_parent_meeting"`
}
func (PresetUpdateParamsPermissionsConnectedMeetings) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsConnectedMeetings) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsMedia ¶
type PresetUpdateParamsPermissionsMedia struct {
// Audio permissions
Audio param.Field[PresetUpdateParamsPermissionsMediaAudio] `json:"audio"`
Screenshare param.Field[PresetUpdateParamsPermissionsMediaScreenshare] `json:"screenshare"`
// Video permissions
Video param.Field[PresetUpdateParamsPermissionsMediaVideo] `json:"video"`
}
Media permissions
func (PresetUpdateParamsPermissionsMedia) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsMedia) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsMediaAudio ¶
type PresetUpdateParamsPermissionsMediaAudio struct {
// Can produce audio
CanProduce param.Field[PresetUpdateParamsPermissionsMediaAudioCanProduce] `json:"can_produce"`
}
Audio permissions
func (PresetUpdateParamsPermissionsMediaAudio) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsMediaAudio) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsMediaAudioCanProduce ¶
type PresetUpdateParamsPermissionsMediaAudioCanProduce string
Can produce audio
const ( PresetUpdateParamsPermissionsMediaAudioCanProduceAllowed PresetUpdateParamsPermissionsMediaAudioCanProduce = "ALLOWED" PresetUpdateParamsPermissionsMediaAudioCanProduceNotAllowed PresetUpdateParamsPermissionsMediaAudioCanProduce = "NOT_ALLOWED" PresetUpdateParamsPermissionsMediaAudioCanProduceCanRequest PresetUpdateParamsPermissionsMediaAudioCanProduce = "CAN_REQUEST" )
func (PresetUpdateParamsPermissionsMediaAudioCanProduce) IsKnown ¶
func (r PresetUpdateParamsPermissionsMediaAudioCanProduce) IsKnown() bool
type PresetUpdateParamsPermissionsMediaScreenshare ¶
type PresetUpdateParamsPermissionsMediaScreenshare struct {
CanProduce param.Field[PresetUpdateParamsPermissionsMediaScreenshareCanProduce] `json:"can_produce"`
}
Screenshare permissions
func (PresetUpdateParamsPermissionsMediaScreenshare) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsMediaScreenshare) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsMediaScreenshareCanProduce ¶
type PresetUpdateParamsPermissionsMediaScreenshareCanProduce string
Can produce screen share video
const ( )
func (PresetUpdateParamsPermissionsMediaScreenshareCanProduce) IsKnown ¶
func (r PresetUpdateParamsPermissionsMediaScreenshareCanProduce) IsKnown() bool
type PresetUpdateParamsPermissionsMediaVideo ¶
type PresetUpdateParamsPermissionsMediaVideo struct {
// Can produce video
CanProduce param.Field[PresetUpdateParamsPermissionsMediaVideoCanProduce] `json:"can_produce"`
}
Video permissions
func (PresetUpdateParamsPermissionsMediaVideo) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsMediaVideo) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsMediaVideoCanProduce ¶
type PresetUpdateParamsPermissionsMediaVideoCanProduce string
Can produce video
const ( PresetUpdateParamsPermissionsMediaVideoCanProduceAllowed PresetUpdateParamsPermissionsMediaVideoCanProduce = "ALLOWED" PresetUpdateParamsPermissionsMediaVideoCanProduceNotAllowed PresetUpdateParamsPermissionsMediaVideoCanProduce = "NOT_ALLOWED" PresetUpdateParamsPermissionsMediaVideoCanProduceCanRequest PresetUpdateParamsPermissionsMediaVideoCanProduce = "CAN_REQUEST" )
func (PresetUpdateParamsPermissionsMediaVideoCanProduce) IsKnown ¶
func (r PresetUpdateParamsPermissionsMediaVideoCanProduce) IsKnown() bool
type PresetUpdateParamsPermissionsPlugins ¶
type PresetUpdateParamsPermissionsPlugins struct {
// Can close plugins that are already open
CanClose param.Field[bool] `json:"can_close"`
// Can edit plugin config
CanEditConfig param.Field[bool] `json:"can_edit_config"`
// Can start plugins
CanStart param.Field[bool] `json:"can_start"`
Config param.Field[PresetUpdateParamsPermissionsPluginsConfigUnion] `json:"config" format:"uuid"`
}
Plugin permissions
func (PresetUpdateParamsPermissionsPlugins) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsPlugins) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsPluginsConfigObject ¶
type PresetUpdateParamsPermissionsPluginsConfigObject struct {
AccessControl param.Field[PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl] `json:"access_control"`
HandlesViewOnly param.Field[bool] `json:"handles_view_only"`
}
func (PresetUpdateParamsPermissionsPluginsConfigObject) ImplementsPresetUpdateParamsPermissionsPluginsConfigUnion ¶
func (r PresetUpdateParamsPermissionsPluginsConfigObject) ImplementsPresetUpdateParamsPermissionsPluginsConfigUnion()
func (PresetUpdateParamsPermissionsPluginsConfigObject) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsPluginsConfigObject) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl ¶
type PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl string
const ( PresetUpdateParamsPermissionsPluginsConfigObjectAccessControlFullAccess PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS" PresetUpdateParamsPermissionsPluginsConfigObjectAccessControlViewOnly PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY" )
func (PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl) IsKnown ¶
func (r PresetUpdateParamsPermissionsPluginsConfigObjectAccessControl) IsKnown() bool
type PresetUpdateParamsPermissionsPluginsConfigUnion ¶
type PresetUpdateParamsPermissionsPluginsConfigUnion interface {
ImplementsPresetUpdateParamsPermissionsPluginsConfigUnion()
}
Satisfied by shared.UnionString, realtime_kit.PresetUpdateParamsPermissionsPluginsConfigObject.
type PresetUpdateParamsPermissionsPolls ¶
type PresetUpdateParamsPermissionsPolls struct {
// Can create polls
CanCreate param.Field[bool] `json:"can_create"`
// Can view polls
CanView param.Field[bool] `json:"can_view"`
// Can vote on polls
CanVote param.Field[bool] `json:"can_vote"`
}
Poll permissions
func (PresetUpdateParamsPermissionsPolls) MarshalJSON ¶
func (r PresetUpdateParamsPermissionsPolls) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsPermissionsRecorderType ¶
type PresetUpdateParamsPermissionsRecorderType string
Type of the recording peer
const ( PresetUpdateParamsPermissionsRecorderTypeRecorder PresetUpdateParamsPermissionsRecorderType = "RECORDER" PresetUpdateParamsPermissionsRecorderTypeLivestreamer PresetUpdateParamsPermissionsRecorderType = "LIVESTREAMER" PresetUpdateParamsPermissionsRecorderTypeNone PresetUpdateParamsPermissionsRecorderType = "NONE" )
func (PresetUpdateParamsPermissionsRecorderType) IsKnown ¶
func (r PresetUpdateParamsPermissionsRecorderType) IsKnown() bool
type PresetUpdateParamsPermissionsWaitingRoomType ¶
type PresetUpdateParamsPermissionsWaitingRoomType string
Waiting room type
const ( PresetUpdateParamsPermissionsWaitingRoomTypeSkip PresetUpdateParamsPermissionsWaitingRoomType = "SKIP" PresetUpdateParamsPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetUpdateParamsPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY" PresetUpdateParamsPermissionsWaitingRoomTypeSkipOnAccept PresetUpdateParamsPermissionsWaitingRoomType = "SKIP_ON_ACCEPT" )
func (PresetUpdateParamsPermissionsWaitingRoomType) IsKnown ¶
func (r PresetUpdateParamsPermissionsWaitingRoomType) IsKnown() bool
type PresetUpdateParamsUI ¶
type PresetUpdateParamsUI struct {
ConfigDiff param.Field[interface{}] `json:"config_diff"`
DesignTokens param.Field[PresetUpdateParamsUIDesignTokens] `json:"design_tokens"`
}
func (PresetUpdateParamsUI) MarshalJSON ¶
func (r PresetUpdateParamsUI) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsUIDesignTokens ¶
type PresetUpdateParamsUIDesignTokens struct {
BorderRadius param.Field[PresetUpdateParamsUIDesignTokensBorderRadius] `json:"border_radius"`
BorderWidth param.Field[PresetUpdateParamsUIDesignTokensBorderWidth] `json:"border_width"`
Colors param.Field[PresetUpdateParamsUIDesignTokensColors] `json:"colors"`
Logo param.Field[string] `json:"logo"`
SpacingBase param.Field[float64] `json:"spacing_base"`
Theme param.Field[PresetUpdateParamsUIDesignTokensTheme] `json:"theme"`
}
func (PresetUpdateParamsUIDesignTokens) MarshalJSON ¶
func (r PresetUpdateParamsUIDesignTokens) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsUIDesignTokensBorderRadius ¶
type PresetUpdateParamsUIDesignTokensBorderRadius string
const (
PresetUpdateParamsUIDesignTokensBorderRadiusRounded PresetUpdateParamsUIDesignTokensBorderRadius = "rounded"
)
func (PresetUpdateParamsUIDesignTokensBorderRadius) IsKnown ¶
func (r PresetUpdateParamsUIDesignTokensBorderRadius) IsKnown() bool
type PresetUpdateParamsUIDesignTokensBorderWidth ¶
type PresetUpdateParamsUIDesignTokensBorderWidth string
const (
PresetUpdateParamsUIDesignTokensBorderWidthThin PresetUpdateParamsUIDesignTokensBorderWidth = "thin"
)
func (PresetUpdateParamsUIDesignTokensBorderWidth) IsKnown ¶
func (r PresetUpdateParamsUIDesignTokensBorderWidth) IsKnown() bool
type PresetUpdateParamsUIDesignTokensColors ¶
type PresetUpdateParamsUIDesignTokensColors struct {
Background param.Field[PresetUpdateParamsUIDesignTokensColorsBackground] `json:"background"`
Brand param.Field[PresetUpdateParamsUIDesignTokensColorsBrand] `json:"brand"`
Danger param.Field[string] `json:"danger"`
Success param.Field[string] `json:"success"`
Text param.Field[string] `json:"text"`
TextOnBrand param.Field[string] `json:"text_on_brand"`
VideoBg param.Field[string] `json:"video_bg"`
Warning param.Field[string] `json:"warning"`
}
func (PresetUpdateParamsUIDesignTokensColors) MarshalJSON ¶
func (r PresetUpdateParamsUIDesignTokensColors) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsUIDesignTokensColorsBackground ¶
type PresetUpdateParamsUIDesignTokensColorsBackground struct {
Number1000 param.Field[string] `json:"1000"`
Number600 param.Field[string] `json:"600"`
Number700 param.Field[string] `json:"700"`
Number800 param.Field[string] `json:"800"`
Number900 param.Field[string] `json:"900"`
}
func (PresetUpdateParamsUIDesignTokensColorsBackground) MarshalJSON ¶
func (r PresetUpdateParamsUIDesignTokensColorsBackground) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsUIDesignTokensColorsBrand ¶
type PresetUpdateParamsUIDesignTokensColorsBrand struct {
Number300 param.Field[string] `json:"300"`
Number400 param.Field[string] `json:"400"`
Number500 param.Field[string] `json:"500"`
Number600 param.Field[string] `json:"600"`
Number700 param.Field[string] `json:"700"`
}
func (PresetUpdateParamsUIDesignTokensColorsBrand) MarshalJSON ¶
func (r PresetUpdateParamsUIDesignTokensColorsBrand) MarshalJSON() (data []byte, err error)
type PresetUpdateParamsUIDesignTokensTheme ¶
type PresetUpdateParamsUIDesignTokensTheme string
const (
PresetUpdateParamsUIDesignTokensThemeDark PresetUpdateParamsUIDesignTokensTheme = "dark"
)
func (PresetUpdateParamsUIDesignTokensTheme) IsKnown ¶
func (r PresetUpdateParamsUIDesignTokensTheme) IsKnown() bool
type PresetUpdateResponse ¶
type PresetUpdateResponse struct {
// Data returned by the operation
Data PresetUpdateResponseData `json:"data" api:"required"`
// Success status of the operation
Success bool `json:"success" api:"required"`
JSON presetUpdateResponseJSON `json:"-"`
}
func (*PresetUpdateResponse) UnmarshalJSON ¶
func (r *PresetUpdateResponse) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseData ¶
type PresetUpdateResponseData struct {
// ID of the preset
ID string `json:"id" api:"required" format:"uuid"`
Config PresetUpdateResponseDataConfig `json:"config" api:"required"`
// Name of the preset
Name string `json:"name" api:"required"`
UI PresetUpdateResponseDataUI `json:"ui" api:"required"`
Permissions PresetUpdateResponseDataPermissions `json:"permissions"`
JSON presetUpdateResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*PresetUpdateResponseData) UnmarshalJSON ¶
func (r *PresetUpdateResponseData) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataConfig ¶
type PresetUpdateResponseDataConfig struct {
MaxScreenshareCount int64 `json:"max_screenshare_count" api:"required"`
// Maximum number of streams that are visible on a device
MaxVideoStreams PresetUpdateResponseDataConfigMaxVideoStreams `json:"max_video_streams" api:"required"`
// Media configuration options. eg: Video quality
Media PresetUpdateResponseDataConfigMedia `json:"media" api:"required"`
// Type of the meeting
ViewType PresetUpdateResponseDataConfigViewType `json:"view_type" api:"required"`
JSON presetUpdateResponseDataConfigJSON `json:"-"`
}
func (*PresetUpdateResponseDataConfig) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataConfig) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataConfigMaxVideoStreams ¶
type PresetUpdateResponseDataConfigMaxVideoStreams struct {
// Maximum number of video streams visible on desktop devices
Desktop int64 `json:"desktop" api:"required"`
// Maximum number of streams visible on mobile devices
Mobile int64 `json:"mobile" api:"required"`
JSON presetUpdateResponseDataConfigMaxVideoStreamsJSON `json:"-"`
}
Maximum number of streams that are visible on a device
func (*PresetUpdateResponseDataConfigMaxVideoStreams) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataConfigMaxVideoStreams) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataConfigMedia ¶
type PresetUpdateResponseDataConfigMedia struct {
Screenshare PresetUpdateResponseDataConfigMediaScreenshare `json:"screenshare" api:"required"`
// Configuration options for participant videos
Video PresetUpdateResponseDataConfigMediaVideo `json:"video" api:"required"`
// Control options for Audio quality.
Audio PresetUpdateResponseDataConfigMediaAudio `json:"audio"`
JSON presetUpdateResponseDataConfigMediaJSON `json:"-"`
}
Media configuration options. eg: Video quality
func (*PresetUpdateResponseDataConfigMedia) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataConfigMedia) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataConfigMediaAudio ¶
type PresetUpdateResponseDataConfigMediaAudio struct {
// Enable High Quality Audio for your meetings
EnableHighBitrate bool `json:"enable_high_bitrate"`
// Enable Stereo for your meetings
EnableStereo bool `json:"enable_stereo"`
JSON presetUpdateResponseDataConfigMediaAudioJSON `json:"-"`
}
Control options for Audio quality.
func (*PresetUpdateResponseDataConfigMediaAudio) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataConfigMediaAudio) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataConfigMediaScreenshare ¶
type PresetUpdateResponseDataConfigMediaScreenshare struct {
FrameRate int64 `json:"frame_rate" api:"required"`
// Quality of screen share
}
Configuration options for participant screen shares
func (*PresetUpdateResponseDataConfigMediaScreenshare) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataConfigMediaScreenshare) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataConfigMediaScreenshareQuality ¶
type PresetUpdateResponseDataConfigMediaScreenshareQuality string
Quality of screen share
const ( )
func (PresetUpdateResponseDataConfigMediaScreenshareQuality) IsKnown ¶
func (r PresetUpdateResponseDataConfigMediaScreenshareQuality) IsKnown() bool
type PresetUpdateResponseDataConfigMediaVideo ¶
type PresetUpdateResponseDataConfigMediaVideo struct {
// Frame rate of participants' video
FrameRate int64 `json:"frame_rate" api:"required"`
// Video quality of participants
Quality PresetUpdateResponseDataConfigMediaVideoQuality `json:"quality" api:"required"`
JSON presetUpdateResponseDataConfigMediaVideoJSON `json:"-"`
}
Configuration options for participant videos
func (*PresetUpdateResponseDataConfigMediaVideo) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataConfigMediaVideo) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataConfigMediaVideoQuality ¶
type PresetUpdateResponseDataConfigMediaVideoQuality string
Video quality of participants
const ( PresetUpdateResponseDataConfigMediaVideoQualityHD PresetUpdateResponseDataConfigMediaVideoQuality = "hd" PresetUpdateResponseDataConfigMediaVideoQualityVga PresetUpdateResponseDataConfigMediaVideoQuality = "vga" PresetUpdateResponseDataConfigMediaVideoQualityQvga PresetUpdateResponseDataConfigMediaVideoQuality = "qvga" )
func (PresetUpdateResponseDataConfigMediaVideoQuality) IsKnown ¶
func (r PresetUpdateResponseDataConfigMediaVideoQuality) IsKnown() bool
type PresetUpdateResponseDataConfigViewType ¶
type PresetUpdateResponseDataConfigViewType string
Type of the meeting
const ( PresetUpdateResponseDataConfigViewTypeGroupCall PresetUpdateResponseDataConfigViewType = "GROUP_CALL" PresetUpdateResponseDataConfigViewTypeWebinar PresetUpdateResponseDataConfigViewType = "WEBINAR" PresetUpdateResponseDataConfigViewTypeAudioRoom PresetUpdateResponseDataConfigViewType = "AUDIO_ROOM" )
func (PresetUpdateResponseDataConfigViewType) IsKnown ¶
func (r PresetUpdateResponseDataConfigViewType) IsKnown() bool
type PresetUpdateResponseDataPermissions ¶
type PresetUpdateResponseDataPermissions struct {
// Whether this participant can accept waiting requests
AcceptWaitingRequests bool `json:"accept_waiting_requests" api:"required"`
CanAcceptProductionRequests bool `json:"can_accept_production_requests" api:"required"`
CanChangeParticipantPermissions bool `json:"can_change_participant_permissions" api:"required"`
CanEditDisplayName bool `json:"can_edit_display_name" api:"required"`
CanLivestream bool `json:"can_livestream" api:"required"`
CanRecord bool `json:"can_record" api:"required"`
CanSpotlight bool `json:"can_spotlight" api:"required"`
// Chat permissions
Chat PresetUpdateResponseDataPermissionsChat `json:"chat" api:"required"`
ConnectedMeetings PresetUpdateResponseDataPermissionsConnectedMeetings `json:"connected_meetings" api:"required"`
DisableParticipantAudio bool `json:"disable_participant_audio" api:"required"`
DisableParticipantScreensharing bool `json:"disable_participant_screensharing" api:"required"`
DisableParticipantVideo bool `json:"disable_participant_video" api:"required"`
// Whether this participant is visible to others or not
HiddenParticipant bool `json:"hidden_participant" api:"required"`
KickParticipant bool `json:"kick_participant" api:"required"`
// Media permissions
Media PresetUpdateResponseDataPermissionsMedia `json:"media" api:"required"`
PinParticipant bool `json:"pin_participant" api:"required"`
// Plugin permissions
Plugins PresetUpdateResponseDataPermissionsPlugins `json:"plugins" api:"required"`
// Poll permissions
Polls PresetUpdateResponseDataPermissionsPolls `json:"polls" api:"required"`
// Type of the recording peer
RecorderType PresetUpdateResponseDataPermissionsRecorderType `json:"recorder_type" api:"required"`
ShowParticipantList bool `json:"show_participant_list" api:"required"`
// Waiting room type
WaitingRoomType PresetUpdateResponseDataPermissionsWaitingRoomType `json:"waiting_room_type" api:"required"`
IsRecorder bool `json:"is_recorder"`
JSON presetUpdateResponseDataPermissionsJSON `json:"-"`
}
func (*PresetUpdateResponseDataPermissions) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissions) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsChat ¶
type PresetUpdateResponseDataPermissionsChat struct {
Private PresetUpdateResponseDataPermissionsChatPrivate `json:"private" api:"required"`
Public PresetUpdateResponseDataPermissionsChatPublic `json:"public" api:"required"`
JSON presetUpdateResponseDataPermissionsChatJSON `json:"-"`
}
Chat permissions
func (*PresetUpdateResponseDataPermissionsChat) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsChat) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsChatPrivate ¶
type PresetUpdateResponseDataPermissionsChatPrivate struct {
CanReceive bool `json:"can_receive" api:"required"`
CanSend bool `json:"can_send" api:"required"`
Files bool `json:"files" api:"required"`
Text bool `json:"text" api:"required"`
JSON presetUpdateResponseDataPermissionsChatPrivateJSON `json:"-"`
}
func (*PresetUpdateResponseDataPermissionsChatPrivate) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsChatPrivate) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsChatPublic ¶
type PresetUpdateResponseDataPermissionsChatPublic struct {
// Can send messages in general
CanSend bool `json:"can_send" api:"required"`
// Can send file messages
Files bool `json:"files" api:"required"`
// Can send text messages
Text bool `json:"text" api:"required"`
JSON presetUpdateResponseDataPermissionsChatPublicJSON `json:"-"`
}
func (*PresetUpdateResponseDataPermissionsChatPublic) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsChatPublic) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsConnectedMeetings ¶
type PresetUpdateResponseDataPermissionsConnectedMeetings struct {
CanAlterConnectedMeetings bool `json:"can_alter_connected_meetings" api:"required"`
CanSwitchConnectedMeetings bool `json:"can_switch_connected_meetings" api:"required"`
CanSwitchToParentMeeting bool `json:"can_switch_to_parent_meeting" api:"required"`
JSON presetUpdateResponseDataPermissionsConnectedMeetingsJSON `json:"-"`
}
func (*PresetUpdateResponseDataPermissionsConnectedMeetings) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsConnectedMeetings) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsMedia ¶
type PresetUpdateResponseDataPermissionsMedia struct {
// Audio permissions
Audio PresetUpdateResponseDataPermissionsMediaAudio `json:"audio" api:"required"`
Screenshare PresetUpdateResponseDataPermissionsMediaScreenshare `json:"screenshare" api:"required"`
// Video permissions
Video PresetUpdateResponseDataPermissionsMediaVideo `json:"video" api:"required"`
JSON presetUpdateResponseDataPermissionsMediaJSON `json:"-"`
}
Media permissions
func (*PresetUpdateResponseDataPermissionsMedia) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsMedia) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsMediaAudio ¶
type PresetUpdateResponseDataPermissionsMediaAudio struct {
// Can produce audio
CanProduce PresetUpdateResponseDataPermissionsMediaAudioCanProduce `json:"can_produce" api:"required"`
JSON presetUpdateResponseDataPermissionsMediaAudioJSON `json:"-"`
}
Audio permissions
func (*PresetUpdateResponseDataPermissionsMediaAudio) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsMediaAudio) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsMediaAudioCanProduce ¶
type PresetUpdateResponseDataPermissionsMediaAudioCanProduce string
Can produce audio
const ( PresetUpdateResponseDataPermissionsMediaAudioCanProduceAllowed PresetUpdateResponseDataPermissionsMediaAudioCanProduce = "ALLOWED" PresetUpdateResponseDataPermissionsMediaAudioCanProduceNotAllowed PresetUpdateResponseDataPermissionsMediaAudioCanProduce = "NOT_ALLOWED" PresetUpdateResponseDataPermissionsMediaAudioCanProduceCanRequest PresetUpdateResponseDataPermissionsMediaAudioCanProduce = "CAN_REQUEST" )
func (PresetUpdateResponseDataPermissionsMediaAudioCanProduce) IsKnown ¶
func (r PresetUpdateResponseDataPermissionsMediaAudioCanProduce) IsKnown() bool
type PresetUpdateResponseDataPermissionsMediaScreenshare ¶
type PresetUpdateResponseDataPermissionsMediaScreenshare struct {
// Can produce screen share video
}
Screenshare permissions
func (*PresetUpdateResponseDataPermissionsMediaScreenshare) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsMediaScreenshare) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce ¶
type PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce string
Can produce screen share video
const ( )
func (PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce) IsKnown ¶
func (r PresetUpdateResponseDataPermissionsMediaScreenshareCanProduce) IsKnown() bool
type PresetUpdateResponseDataPermissionsMediaVideo ¶
type PresetUpdateResponseDataPermissionsMediaVideo struct {
// Can produce video
CanProduce PresetUpdateResponseDataPermissionsMediaVideoCanProduce `json:"can_produce" api:"required"`
JSON presetUpdateResponseDataPermissionsMediaVideoJSON `json:"-"`
}
Video permissions
func (*PresetUpdateResponseDataPermissionsMediaVideo) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsMediaVideo) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsMediaVideoCanProduce ¶
type PresetUpdateResponseDataPermissionsMediaVideoCanProduce string
Can produce video
const ( PresetUpdateResponseDataPermissionsMediaVideoCanProduceAllowed PresetUpdateResponseDataPermissionsMediaVideoCanProduce = "ALLOWED" PresetUpdateResponseDataPermissionsMediaVideoCanProduceNotAllowed PresetUpdateResponseDataPermissionsMediaVideoCanProduce = "NOT_ALLOWED" PresetUpdateResponseDataPermissionsMediaVideoCanProduceCanRequest PresetUpdateResponseDataPermissionsMediaVideoCanProduce = "CAN_REQUEST" )
func (PresetUpdateResponseDataPermissionsMediaVideoCanProduce) IsKnown ¶
func (r PresetUpdateResponseDataPermissionsMediaVideoCanProduce) IsKnown() bool
type PresetUpdateResponseDataPermissionsPlugins ¶
type PresetUpdateResponseDataPermissionsPlugins struct {
// Can close plugins that are already open
CanClose bool `json:"can_close" api:"required"`
// Can edit plugin config
CanEditConfig bool `json:"can_edit_config" api:"required"`
// Can start plugins
CanStart bool `json:"can_start" api:"required"`
Config PresetUpdateResponseDataPermissionsPluginsConfigUnion `json:"config" api:"required" format:"uuid"`
JSON presetUpdateResponseDataPermissionsPluginsJSON `json:"-"`
}
Plugin permissions
func (*PresetUpdateResponseDataPermissionsPlugins) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsPlugins) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsPluginsConfigObject ¶
type PresetUpdateResponseDataPermissionsPluginsConfigObject struct {
AccessControl PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl `json:"access_control" api:"required"`
HandlesViewOnly bool `json:"handles_view_only" api:"required"`
JSON presetUpdateResponseDataPermissionsPluginsConfigObjectJSON `json:"-"`
}
func (PresetUpdateResponseDataPermissionsPluginsConfigObject) ImplementsPresetUpdateResponseDataPermissionsPluginsConfigUnion ¶
func (r PresetUpdateResponseDataPermissionsPluginsConfigObject) ImplementsPresetUpdateResponseDataPermissionsPluginsConfigUnion()
func (*PresetUpdateResponseDataPermissionsPluginsConfigObject) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsPluginsConfigObject) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl ¶
type PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl string
const ( PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControlFullAccess PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl = "FULL_ACCESS" PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControlViewOnly PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl = "VIEW_ONLY" )
func (PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown ¶
func (r PresetUpdateResponseDataPermissionsPluginsConfigObjectAccessControl) IsKnown() bool
type PresetUpdateResponseDataPermissionsPluginsConfigUnion ¶
type PresetUpdateResponseDataPermissionsPluginsConfigUnion interface {
ImplementsPresetUpdateResponseDataPermissionsPluginsConfigUnion()
}
Union satisfied by shared.UnionString or PresetUpdateResponseDataPermissionsPluginsConfigObject.
type PresetUpdateResponseDataPermissionsPolls ¶
type PresetUpdateResponseDataPermissionsPolls struct {
// Can create polls
CanCreate bool `json:"can_create" api:"required"`
// Can view polls
CanView bool `json:"can_view" api:"required"`
// Can vote on polls
CanVote bool `json:"can_vote" api:"required"`
JSON presetUpdateResponseDataPermissionsPollsJSON `json:"-"`
}
Poll permissions
func (*PresetUpdateResponseDataPermissionsPolls) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataPermissionsPolls) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataPermissionsRecorderType ¶
type PresetUpdateResponseDataPermissionsRecorderType string
Type of the recording peer
const ( PresetUpdateResponseDataPermissionsRecorderTypeRecorder PresetUpdateResponseDataPermissionsRecorderType = "RECORDER" PresetUpdateResponseDataPermissionsRecorderTypeLivestreamer PresetUpdateResponseDataPermissionsRecorderType = "LIVESTREAMER" PresetUpdateResponseDataPermissionsRecorderTypeNone PresetUpdateResponseDataPermissionsRecorderType = "NONE" )
func (PresetUpdateResponseDataPermissionsRecorderType) IsKnown ¶
func (r PresetUpdateResponseDataPermissionsRecorderType) IsKnown() bool
type PresetUpdateResponseDataPermissionsWaitingRoomType ¶
type PresetUpdateResponseDataPermissionsWaitingRoomType string
Waiting room type
const ( PresetUpdateResponseDataPermissionsWaitingRoomTypeSkip PresetUpdateResponseDataPermissionsWaitingRoomType = "SKIP" PresetUpdateResponseDataPermissionsWaitingRoomTypeOnPrivilegedUserEntry PresetUpdateResponseDataPermissionsWaitingRoomType = "ON_PRIVILEGED_USER_ENTRY" PresetUpdateResponseDataPermissionsWaitingRoomTypeSkipOnAccept PresetUpdateResponseDataPermissionsWaitingRoomType = "SKIP_ON_ACCEPT" )
func (PresetUpdateResponseDataPermissionsWaitingRoomType) IsKnown ¶
func (r PresetUpdateResponseDataPermissionsWaitingRoomType) IsKnown() bool
type PresetUpdateResponseDataUI ¶
type PresetUpdateResponseDataUI struct {
DesignTokens PresetUpdateResponseDataUIDesignTokens `json:"design_tokens" api:"required"`
ConfigDiff interface{} `json:"config_diff"`
JSON presetUpdateResponseDataUIJSON `json:"-"`
}
func (*PresetUpdateResponseDataUI) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataUI) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataUIDesignTokens ¶
type PresetUpdateResponseDataUIDesignTokens struct {
BorderRadius PresetUpdateResponseDataUIDesignTokensBorderRadius `json:"border_radius" api:"required"`
BorderWidth PresetUpdateResponseDataUIDesignTokensBorderWidth `json:"border_width" api:"required"`
Colors PresetUpdateResponseDataUIDesignTokensColors `json:"colors" api:"required"`
Logo string `json:"logo" api:"required"`
SpacingBase float64 `json:"spacing_base" api:"required"`
Theme PresetUpdateResponseDataUIDesignTokensTheme `json:"theme" api:"required"`
JSON presetUpdateResponseDataUIDesignTokensJSON `json:"-"`
}
func (*PresetUpdateResponseDataUIDesignTokens) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataUIDesignTokens) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataUIDesignTokensBorderRadius ¶
type PresetUpdateResponseDataUIDesignTokensBorderRadius string
const (
PresetUpdateResponseDataUIDesignTokensBorderRadiusRounded PresetUpdateResponseDataUIDesignTokensBorderRadius = "rounded"
)
func (PresetUpdateResponseDataUIDesignTokensBorderRadius) IsKnown ¶
func (r PresetUpdateResponseDataUIDesignTokensBorderRadius) IsKnown() bool
type PresetUpdateResponseDataUIDesignTokensBorderWidth ¶
type PresetUpdateResponseDataUIDesignTokensBorderWidth string
const (
PresetUpdateResponseDataUIDesignTokensBorderWidthThin PresetUpdateResponseDataUIDesignTokensBorderWidth = "thin"
)
func (PresetUpdateResponseDataUIDesignTokensBorderWidth) IsKnown ¶
func (r PresetUpdateResponseDataUIDesignTokensBorderWidth) IsKnown() bool
type PresetUpdateResponseDataUIDesignTokensColors ¶
type PresetUpdateResponseDataUIDesignTokensColors struct {
Background PresetUpdateResponseDataUIDesignTokensColorsBackground `json:"background" api:"required"`
Brand PresetUpdateResponseDataUIDesignTokensColorsBrand `json:"brand" api:"required"`
Danger string `json:"danger" api:"required"`
Success string `json:"success" api:"required"`
Text string `json:"text" api:"required"`
TextOnBrand string `json:"text_on_brand" api:"required"`
VideoBg string `json:"video_bg" api:"required"`
Warning string `json:"warning" api:"required"`
JSON presetUpdateResponseDataUIDesignTokensColorsJSON `json:"-"`
}
func (*PresetUpdateResponseDataUIDesignTokensColors) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataUIDesignTokensColors) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataUIDesignTokensColorsBackground ¶
type PresetUpdateResponseDataUIDesignTokensColorsBackground struct {
Number1000 string `json:"1000" api:"required"`
Number600 string `json:"600" api:"required"`
Number700 string `json:"700" api:"required"`
Number800 string `json:"800" api:"required"`
Number900 string `json:"900" api:"required"`
JSON presetUpdateResponseDataUIDesignTokensColorsBackgroundJSON `json:"-"`
}
func (*PresetUpdateResponseDataUIDesignTokensColorsBackground) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataUIDesignTokensColorsBackground) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataUIDesignTokensColorsBrand ¶
type PresetUpdateResponseDataUIDesignTokensColorsBrand struct {
Number300 string `json:"300" api:"required"`
Number400 string `json:"400" api:"required"`
Number500 string `json:"500" api:"required"`
Number600 string `json:"600" api:"required"`
Number700 string `json:"700" api:"required"`
JSON presetUpdateResponseDataUIDesignTokensColorsBrandJSON `json:"-"`
}
func (*PresetUpdateResponseDataUIDesignTokensColorsBrand) UnmarshalJSON ¶
func (r *PresetUpdateResponseDataUIDesignTokensColorsBrand) UnmarshalJSON(data []byte) (err error)
type PresetUpdateResponseDataUIDesignTokensTheme ¶
type PresetUpdateResponseDataUIDesignTokensTheme string
const (
PresetUpdateResponseDataUIDesignTokensThemeDark PresetUpdateResponseDataUIDesignTokensTheme = "dark"
)
func (PresetUpdateResponseDataUIDesignTokensTheme) IsKnown ¶
func (r PresetUpdateResponseDataUIDesignTokensTheme) IsKnown() bool
type RatePlanID ¶
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
This is an alias to an internal type.
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type RealtimeKitService ¶
type RealtimeKitService struct {
Options []option.RequestOption
Apps *AppService
Meetings *MeetingService
Presets *PresetService
Sessions *SessionService
Recordings *RecordingService
Webhooks *WebhookService
ActiveSession *ActiveSessionService
Livestreams *LivestreamService
Analytics *AnalyticsService
}
RealtimeKitService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRealtimeKitService method instead.
func NewRealtimeKitService ¶
func NewRealtimeKitService(opts ...option.RequestOption) (r *RealtimeKitService)
NewRealtimeKitService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
type RecordingGetActiveRecordingsResponse ¶
type RecordingGetActiveRecordingsResponse struct {
// Data returned by the operation
Data RecordingGetActiveRecordingsResponseData `json:"data" api:"required"`
// Success status of the operation
Success bool `json:"success" api:"required"`
JSON recordingGetActiveRecordingsResponseJSON `json:"-"`
}
func (*RecordingGetActiveRecordingsResponse) UnmarshalJSON ¶
func (r *RecordingGetActiveRecordingsResponse) UnmarshalJSON(data []byte) (err error)
type RecordingGetActiveRecordingsResponseData ¶
type RecordingGetActiveRecordingsResponseData struct {
// ID of the recording
ID string `json:"id" api:"required" format:"uuid"`
// If the audio_config is passed, the URL for downloading the audio recording is
// returned.
AudioDownloadURL string `json:"audio_download_url" api:"required,nullable" format:"uri"`
// URL where the recording can be downloaded.
DownloadURL string `json:"download_url" api:"required,nullable" format:"uri"`
// Timestamp when the download URL expires.
DownloadURLExpiry time.Time `json:"download_url_expiry" api:"required,nullable" format:"date-time"`
// File size of the recording, in bytes.
FileSize float64 `json:"file_size" api:"required,nullable"`
// Timestamp when this recording was invoked.
InvokedTime time.Time `json:"invoked_time" api:"required" format:"date-time"`
// File name of the recording.
OutputFileName string `json:"output_file_name" api:"required"`
// ID of the meeting session this recording is for.
SessionID string `json:"session_id" api:"required,nullable" format:"uuid"`
// Timestamp when this recording actually started after being invoked. Usually a
// few seconds after `invoked_time`.
StartedTime time.Time `json:"started_time" api:"required,nullable" format:"date-time"`
// Current status of the recording.
Status RecordingGetActiveRecordingsResponseDataStatus `json:"status" api:"required"`
// Timestamp when this recording was stopped. Optional; is present only when the
// recording has actually been stopped.
StoppedTime time.Time `json:"stopped_time" api:"required,nullable" format:"date-time"`
// Total recording time in seconds.
RecordingDuration int64 `json:"recording_duration"`
JSON recordingGetActiveRecordingsResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*RecordingGetActiveRecordingsResponseData) UnmarshalJSON ¶
func (r *RecordingGetActiveRecordingsResponseData) UnmarshalJSON(data []byte) (err error)
type RecordingGetActiveRecordingsResponseDataStatus ¶
type RecordingGetActiveRecordingsResponseDataStatus string
Current status of the recording.
const ( RecordingGetActiveRecordingsResponseDataStatusInvoked RecordingGetActiveRecordingsResponseDataStatus = "INVOKED" RecordingGetActiveRecordingsResponseDataStatusRecording RecordingGetActiveRecordingsResponseDataStatus = "RECORDING" RecordingGetActiveRecordingsResponseDataStatusUploading RecordingGetActiveRecordingsResponseDataStatus = "UPLOADING" RecordingGetActiveRecordingsResponseDataStatusUploaded RecordingGetActiveRecordingsResponseDataStatus = "UPLOADED" RecordingGetActiveRecordingsResponseDataStatusErrored RecordingGetActiveRecordingsResponseDataStatus = "ERRORED" RecordingGetActiveRecordingsResponseDataStatusPaused RecordingGetActiveRecordingsResponseDataStatus = "PAUSED" )
func (RecordingGetActiveRecordingsResponseDataStatus) IsKnown ¶
func (r RecordingGetActiveRecordingsResponseDataStatus) IsKnown() bool
type RecordingGetOneRecordingResponse ¶
type RecordingGetOneRecordingResponse struct {
// Success status of the operation
Success bool `json:"success" api:"required"`
// Data returned by the operation
Data RecordingGetOneRecordingResponseData `json:"data"`
JSON recordingGetOneRecordingResponseJSON `json:"-"`
}
func (*RecordingGetOneRecordingResponse) UnmarshalJSON ¶
func (r *RecordingGetOneRecordingResponse) UnmarshalJSON(data []byte) (err error)
type RecordingGetOneRecordingResponseData ¶
type RecordingGetOneRecordingResponseData struct {
// ID of the recording
ID string `json:"id" api:"required" format:"uuid"`
// If the audio_config is passed, the URL for downloading the audio recording is
// returned.
AudioDownloadURL string `json:"audio_download_url" api:"required,nullable" format:"uri"`
// URL where the recording can be downloaded.
DownloadURL string `json:"download_url" api:"required,nullable" format:"uri"`
// Timestamp when the download URL expires.
DownloadURLExpiry time.Time `json:"download_url_expiry" api:"required,nullable" format:"date-time"`
// File size of the recording, in bytes.
FileSize float64 `json:"file_size" api:"required,nullable"`
// Timestamp when this recording was invoked.
InvokedTime time.Time `json:"invoked_time" api:"required" format:"date-time"`
// File name of the recording.
OutputFileName string `json:"output_file_name" api:"required"`
// ID of the meeting session this recording is for.
SessionID string `json:"session_id" api:"required,nullable" format:"uuid"`
// Timestamp when this recording actually started after being invoked. Usually a
// few seconds after `invoked_time`.
StartedTime time.Time `json:"started_time" api:"required,nullable" format:"date-time"`
// Current status of the recording.
Status RecordingGetOneRecordingResponseDataStatus `json:"status" api:"required"`
// Timestamp when this recording was stopped. Optional; is present only when the
// recording has actually been stopped.
StoppedTime time.Time `json:"stopped_time" api:"required,nullable" format:"date-time"`
// Total recording time in seconds.
RecordingDuration int64 `json:"recording_duration"`
StartReason RecordingGetOneRecordingResponseDataStartReason `json:"start_reason"`
StopReason RecordingGetOneRecordingResponseDataStopReason `json:"stop_reason"`
StorageConfig RecordingGetOneRecordingResponseDataStorageConfig `json:"storage_config" api:"nullable"`
JSON recordingGetOneRecordingResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*RecordingGetOneRecordingResponseData) UnmarshalJSON ¶
func (r *RecordingGetOneRecordingResponseData) UnmarshalJSON(data []byte) (err error)
type RecordingGetOneRecordingResponseDataStartReason ¶
type RecordingGetOneRecordingResponseDataStartReason struct {
Caller RecordingGetOneRecordingResponseDataStartReasonCaller `json:"caller"`
// Specifies if the recording was started using the "Start a Recording"API or using
// the parameter RECORD_ON_START in the "Create a meeting" API.
//
// If the recording is initiated using the "RECORD_ON_START" parameter, the user
// details will not be populated.
Reason RecordingGetOneRecordingResponseDataStartReasonReason `json:"reason"`
JSON recordingGetOneRecordingResponseDataStartReasonJSON `json:"-"`
}
func (*RecordingGetOneRecordingResponseDataStartReason) UnmarshalJSON ¶
func (r *RecordingGetOneRecordingResponseDataStartReason) UnmarshalJSON(data []byte) (err error)
type RecordingGetOneRecordingResponseDataStartReasonCaller ¶
type RecordingGetOneRecordingResponseDataStartReasonCaller struct {
// Name of the user who started the recording.
Name string `json:"name"`
// The type can be an App or a user. If the type is `user`, then only the `user_Id`
// and `name` are returned.
Type RecordingGetOneRecordingResponseDataStartReasonCallerType `json:"type"`
// The user ID of the person who started the recording.
UserID string `json:"user_Id" format:"uuid"`
JSON recordingGetOneRecordingResponseDataStartReasonCallerJSON `json:"-"`
}
func (*RecordingGetOneRecordingResponseDataStartReasonCaller) UnmarshalJSON ¶
func (r *RecordingGetOneRecordingResponseDataStartReasonCaller) UnmarshalJSON(data []byte) (err error)
type RecordingGetOneRecordingResponseDataStartReasonCallerType ¶
type RecordingGetOneRecordingResponseDataStartReasonCallerType string
The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.
const ( RecordingGetOneRecordingResponseDataStartReasonCallerTypeOrganization RecordingGetOneRecordingResponseDataStartReasonCallerType = "ORGANIZATION" RecordingGetOneRecordingResponseDataStartReasonCallerTypeUser RecordingGetOneRecordingResponseDataStartReasonCallerType = "USER" )
func (RecordingGetOneRecordingResponseDataStartReasonCallerType) IsKnown ¶
func (r RecordingGetOneRecordingResponseDataStartReasonCallerType) IsKnown() bool
type RecordingGetOneRecordingResponseDataStartReasonReason ¶
type RecordingGetOneRecordingResponseDataStartReasonReason string
Specifies if the recording was started using the "Start a Recording"API or using the parameter RECORD_ON_START in the "Create a meeting" API.
If the recording is initiated using the "RECORD_ON_START" parameter, the user details will not be populated.
const ( RecordingGetOneRecordingResponseDataStartReasonReasonAPICall RecordingGetOneRecordingResponseDataStartReasonReason = "API_CALL" RecordingGetOneRecordingResponseDataStartReasonReasonRecordOnStart RecordingGetOneRecordingResponseDataStartReasonReason = "RECORD_ON_START" )
func (RecordingGetOneRecordingResponseDataStartReasonReason) IsKnown ¶
func (r RecordingGetOneRecordingResponseDataStartReasonReason) IsKnown() bool
type RecordingGetOneRecordingResponseDataStatus ¶
type RecordingGetOneRecordingResponseDataStatus string
Current status of the recording.
const ( RecordingGetOneRecordingResponseDataStatusInvoked RecordingGetOneRecordingResponseDataStatus = "INVOKED" RecordingGetOneRecordingResponseDataStatusRecording RecordingGetOneRecordingResponseDataStatus = "RECORDING" RecordingGetOneRecordingResponseDataStatusUploading RecordingGetOneRecordingResponseDataStatus = "UPLOADING" RecordingGetOneRecordingResponseDataStatusUploaded RecordingGetOneRecordingResponseDataStatus = "UPLOADED" RecordingGetOneRecordingResponseDataStatusErrored RecordingGetOneRecordingResponseDataStatus = "ERRORED" RecordingGetOneRecordingResponseDataStatusPaused RecordingGetOneRecordingResponseDataStatus = "PAUSED" )
func (RecordingGetOneRecordingResponseDataStatus) IsKnown ¶
func (r RecordingGetOneRecordingResponseDataStatus) IsKnown() bool
type RecordingGetOneRecordingResponseDataStopReason ¶
type RecordingGetOneRecordingResponseDataStopReason struct {
Caller RecordingGetOneRecordingResponseDataStopReasonCaller `json:"caller"`
// Specifies the reason why the recording stopped.
Reason RecordingGetOneRecordingResponseDataStopReasonReason `json:"reason"`
JSON recordingGetOneRecordingResponseDataStopReasonJSON `json:"-"`
}
func (*RecordingGetOneRecordingResponseDataStopReason) UnmarshalJSON ¶
func (r *RecordingGetOneRecordingResponseDataStopReason) UnmarshalJSON(data []byte) (err error)
type RecordingGetOneRecordingResponseDataStopReasonCaller ¶
type RecordingGetOneRecordingResponseDataStopReasonCaller struct {
// Name of the user who stopped the recording.
Name string `json:"name"`
// The type can be an App or a user. If the type is `user`, then only the `user_Id`
// and `name` are returned.
Type RecordingGetOneRecordingResponseDataStopReasonCallerType `json:"type"`
// The user ID of the person who stopped the recording.
UserID string `json:"user_Id" format:"uuid"`
JSON recordingGetOneRecordingResponseDataStopReasonCallerJSON `json:"-"`
}
func (*RecordingGetOneRecordingResponseDataStopReasonCaller) UnmarshalJSON ¶
func (r *RecordingGetOneRecordingResponseDataStopReasonCaller) UnmarshalJSON(data []byte) (err error)
type RecordingGetOneRecordingResponseDataStopReasonCallerType ¶
type RecordingGetOneRecordingResponseDataStopReasonCallerType string
The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.
const ( RecordingGetOneRecordingResponseDataStopReasonCallerTypeOrganization RecordingGetOneRecordingResponseDataStopReasonCallerType = "ORGANIZATION" RecordingGetOneRecordingResponseDataStopReasonCallerTypeUser RecordingGetOneRecordingResponseDataStopReasonCallerType = "USER" )
func (RecordingGetOneRecordingResponseDataStopReasonCallerType) IsKnown ¶
func (r RecordingGetOneRecordingResponseDataStopReasonCallerType) IsKnown() bool
type RecordingGetOneRecordingResponseDataStopReasonReason ¶
type RecordingGetOneRecordingResponseDataStopReasonReason string
Specifies the reason why the recording stopped.
const ( RecordingGetOneRecordingResponseDataStopReasonReasonAPICall RecordingGetOneRecordingResponseDataStopReasonReason = "API_CALL" RecordingGetOneRecordingResponseDataStopReasonReasonInternalError RecordingGetOneRecordingResponseDataStopReasonReason = "INTERNAL_ERROR" RecordingGetOneRecordingResponseDataStopReasonReasonAllPeersLeft RecordingGetOneRecordingResponseDataStopReasonReason = "ALL_PEERS_LEFT" )
func (RecordingGetOneRecordingResponseDataStopReasonReason) IsKnown ¶
func (r RecordingGetOneRecordingResponseDataStopReasonReason) IsKnown() bool
type RecordingGetOneRecordingResponseDataStorageConfig ¶
type RecordingGetOneRecordingResponseDataStorageConfig struct {
// Type of storage media.
Type RecordingGetOneRecordingResponseDataStorageConfigType `json:"type" api:"required"`
// Authentication method used for "sftp" type storage medium
AuthMethod RecordingGetOneRecordingResponseDataStorageConfigAuthMethod `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket string `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host string `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password string `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path string `json:"path"`
// SSH destination server port for SFTP type storage medium
Port float64 `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey string `json:"private_key"`
// Region of the storage medium.
Region string `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret string `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username string `json:"username"`
JSON recordingGetOneRecordingResponseDataStorageConfigJSON `json:"-"`
}
func (*RecordingGetOneRecordingResponseDataStorageConfig) UnmarshalJSON ¶
func (r *RecordingGetOneRecordingResponseDataStorageConfig) UnmarshalJSON(data []byte) (err error)
type RecordingGetOneRecordingResponseDataStorageConfigAuthMethod ¶
type RecordingGetOneRecordingResponseDataStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( RecordingGetOneRecordingResponseDataStorageConfigAuthMethodKey RecordingGetOneRecordingResponseDataStorageConfigAuthMethod = "KEY" RecordingGetOneRecordingResponseDataStorageConfigAuthMethodPassword RecordingGetOneRecordingResponseDataStorageConfigAuthMethod = "PASSWORD" )
func (RecordingGetOneRecordingResponseDataStorageConfigAuthMethod) IsKnown ¶
func (r RecordingGetOneRecordingResponseDataStorageConfigAuthMethod) IsKnown() bool
type RecordingGetOneRecordingResponseDataStorageConfigType ¶
type RecordingGetOneRecordingResponseDataStorageConfigType string
Type of storage media.
const ( RecordingGetOneRecordingResponseDataStorageConfigTypeAws RecordingGetOneRecordingResponseDataStorageConfigType = "aws" RecordingGetOneRecordingResponseDataStorageConfigTypeAzure RecordingGetOneRecordingResponseDataStorageConfigType = "azure" RecordingGetOneRecordingResponseDataStorageConfigTypeDigitalocean RecordingGetOneRecordingResponseDataStorageConfigType = "digitalocean" RecordingGetOneRecordingResponseDataStorageConfigTypeGcs RecordingGetOneRecordingResponseDataStorageConfigType = "gcs" RecordingGetOneRecordingResponseDataStorageConfigTypeSftp RecordingGetOneRecordingResponseDataStorageConfigType = "sftp" )
func (RecordingGetOneRecordingResponseDataStorageConfigType) IsKnown ¶
func (r RecordingGetOneRecordingResponseDataStorageConfigType) IsKnown() bool
type RecordingGetRecordingsParams ¶
type RecordingGetRecordingsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// The end time range for which you want to retrieve the meetings. The time must be
// specified in ISO format.
EndTime param.Field[time.Time] `query:"end_time" format:"date-time"`
// If passed, only shows expired/non-expired recordings on RealtimeKit's bucket
Expired param.Field[bool] `query:"expired"`
// ID of a meeting. Optional. Will limit results to only this meeting if passed.
MeetingID param.Field[string] `query:"meeting_id" format:"uuid"`
// The page number from which you want your page search results to be displayed.
PageNo param.Field[float64] `query:"page_no"`
// Number of results per page
PerPage param.Field[float64] `query:"per_page"`
// The search query string. You can search using the meeting ID or title.
Search param.Field[string] `query:"search"`
SortBy param.Field[RecordingGetRecordingsParamsSortBy] `query:"sort_by"`
SortOrder param.Field[RecordingGetRecordingsParamsSortOrder] `query:"sort_order"`
// The start time range for which you want to retrieve the meetings. The time must
// be specified in ISO format.
StartTime param.Field[time.Time] `query:"start_time" format:"date-time"`
// Filter by one or more recording status
Status param.Field[[]RecordingGetRecordingsParamsStatus] `query:"status"`
}
func (RecordingGetRecordingsParams) URLQuery ¶
func (r RecordingGetRecordingsParams) URLQuery() (v url.Values)
URLQuery serializes RecordingGetRecordingsParams's query parameters as `url.Values`.
type RecordingGetRecordingsParamsSortBy ¶
type RecordingGetRecordingsParamsSortBy string
const (
RecordingGetRecordingsParamsSortByInvokedTime RecordingGetRecordingsParamsSortBy = "invokedTime"
)
func (RecordingGetRecordingsParamsSortBy) IsKnown ¶
func (r RecordingGetRecordingsParamsSortBy) IsKnown() bool
type RecordingGetRecordingsParamsSortOrder ¶
type RecordingGetRecordingsParamsSortOrder string
const ( RecordingGetRecordingsParamsSortOrderAsc RecordingGetRecordingsParamsSortOrder = "ASC" RecordingGetRecordingsParamsSortOrderDesc RecordingGetRecordingsParamsSortOrder = "DESC" )
func (RecordingGetRecordingsParamsSortOrder) IsKnown ¶
func (r RecordingGetRecordingsParamsSortOrder) IsKnown() bool
type RecordingGetRecordingsParamsStatus ¶
type RecordingGetRecordingsParamsStatus string
const ( RecordingGetRecordingsParamsStatusInvoked RecordingGetRecordingsParamsStatus = "INVOKED" RecordingGetRecordingsParamsStatusRecording RecordingGetRecordingsParamsStatus = "RECORDING" RecordingGetRecordingsParamsStatusUploading RecordingGetRecordingsParamsStatus = "UPLOADING" RecordingGetRecordingsParamsStatusUploaded RecordingGetRecordingsParamsStatus = "UPLOADED" )
func (RecordingGetRecordingsParamsStatus) IsKnown ¶
func (r RecordingGetRecordingsParamsStatus) IsKnown() bool
type RecordingGetRecordingsResponse ¶
type RecordingGetRecordingsResponse struct {
Data []RecordingGetRecordingsResponseData `json:"data" api:"required"`
Paging RecordingGetRecordingsResponsePaging `json:"paging" api:"required"`
Success bool `json:"success" api:"required"`
JSON recordingGetRecordingsResponseJSON `json:"-"`
}
func (*RecordingGetRecordingsResponse) UnmarshalJSON ¶
func (r *RecordingGetRecordingsResponse) UnmarshalJSON(data []byte) (err error)
type RecordingGetRecordingsResponseData ¶
type RecordingGetRecordingsResponseData struct {
// ID of the recording
ID string `json:"id" api:"required" format:"uuid"`
// If the audio_config is passed, the URL for downloading the audio recording is
// returned.
AudioDownloadURL string `json:"audio_download_url" api:"required,nullable" format:"uri"`
// URL where the recording can be downloaded.
DownloadURL string `json:"download_url" api:"required,nullable" format:"uri"`
// Timestamp when the download URL expires.
DownloadURLExpiry time.Time `json:"download_url_expiry" api:"required,nullable" format:"date-time"`
// File size of the recording, in bytes.
FileSize float64 `json:"file_size" api:"required,nullable"`
// Timestamp when this recording was invoked.
InvokedTime time.Time `json:"invoked_time" api:"required" format:"date-time"`
// File name of the recording.
OutputFileName string `json:"output_file_name" api:"required"`
// ID of the meeting session this recording is for.
SessionID string `json:"session_id" api:"required,nullable" format:"uuid"`
// Timestamp when this recording actually started after being invoked. Usually a
// few seconds after `invoked_time`.
StartedTime time.Time `json:"started_time" api:"required,nullable" format:"date-time"`
// Current status of the recording.
Status RecordingGetRecordingsResponseDataStatus `json:"status" api:"required"`
// Timestamp when this recording was stopped. Optional; is present only when the
// recording has actually been stopped.
StoppedTime time.Time `json:"stopped_time" api:"required,nullable" format:"date-time"`
Meeting RecordingGetRecordingsResponseDataMeeting `json:"meeting"`
// Total recording time in seconds.
RecordingDuration int64 `json:"recording_duration"`
StorageConfig RecordingGetRecordingsResponseDataStorageConfig `json:"storage_config" api:"nullable"`
JSON recordingGetRecordingsResponseDataJSON `json:"-"`
}
func (*RecordingGetRecordingsResponseData) UnmarshalJSON ¶
func (r *RecordingGetRecordingsResponseData) UnmarshalJSON(data []byte) (err error)
type RecordingGetRecordingsResponseDataMeeting ¶
type RecordingGetRecordingsResponseDataMeeting struct {
// ID of the meeting.
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp the object was created at. The time is returned in ISO format.
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Timestamp the object was updated at. The time is returned in ISO format.
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// Specifies if the meeting should start getting livestreamed on start.
LiveStreamOnStart bool `json:"live_stream_on_start"`
// Specifies if Chat within a meeting should persist for a week.
PersistChat bool `json:"persist_chat"`
// Specifies if the meeting should start getting recorded as soon as someone joins
// the meeting.
RecordOnStart bool `json:"record_on_start"`
// Time in seconds, for which a session remains active, after the last participant
// has left the meeting.
SessionKeepAliveTimeInSecs float64 `json:"session_keep_alive_time_in_secs"`
// Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an
// `INACTIVE` meeting.
Status RecordingGetRecordingsResponseDataMeetingStatus `json:"status"`
// Automatically generate summary of meetings using transcripts. Requires
// Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
SummarizeOnEnd bool `json:"summarize_on_end"`
// Title of the meeting.
Title string `json:"title"`
JSON recordingGetRecordingsResponseDataMeetingJSON `json:"-"`
}
func (*RecordingGetRecordingsResponseDataMeeting) UnmarshalJSON ¶
func (r *RecordingGetRecordingsResponseDataMeeting) UnmarshalJSON(data []byte) (err error)
type RecordingGetRecordingsResponseDataMeetingStatus ¶
type RecordingGetRecordingsResponseDataMeetingStatus string
Whether the meeting is `ACTIVE` or `INACTIVE`. Users will not be able to join an `INACTIVE` meeting.
const ( RecordingGetRecordingsResponseDataMeetingStatusActive RecordingGetRecordingsResponseDataMeetingStatus = "ACTIVE" RecordingGetRecordingsResponseDataMeetingStatusInactive RecordingGetRecordingsResponseDataMeetingStatus = "INACTIVE" )
func (RecordingGetRecordingsResponseDataMeetingStatus) IsKnown ¶
func (r RecordingGetRecordingsResponseDataMeetingStatus) IsKnown() bool
type RecordingGetRecordingsResponseDataStatus ¶
type RecordingGetRecordingsResponseDataStatus string
Current status of the recording.
const ( RecordingGetRecordingsResponseDataStatusInvoked RecordingGetRecordingsResponseDataStatus = "INVOKED" RecordingGetRecordingsResponseDataStatusRecording RecordingGetRecordingsResponseDataStatus = "RECORDING" RecordingGetRecordingsResponseDataStatusUploading RecordingGetRecordingsResponseDataStatus = "UPLOADING" RecordingGetRecordingsResponseDataStatusUploaded RecordingGetRecordingsResponseDataStatus = "UPLOADED" RecordingGetRecordingsResponseDataStatusErrored RecordingGetRecordingsResponseDataStatus = "ERRORED" RecordingGetRecordingsResponseDataStatusPaused RecordingGetRecordingsResponseDataStatus = "PAUSED" )
func (RecordingGetRecordingsResponseDataStatus) IsKnown ¶
func (r RecordingGetRecordingsResponseDataStatus) IsKnown() bool
type RecordingGetRecordingsResponseDataStorageConfig ¶
type RecordingGetRecordingsResponseDataStorageConfig struct {
// Type of storage media.
Type RecordingGetRecordingsResponseDataStorageConfigType `json:"type" api:"required"`
// Authentication method used for "sftp" type storage medium
AuthMethod RecordingGetRecordingsResponseDataStorageConfigAuthMethod `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket string `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host string `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password string `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path string `json:"path"`
// SSH destination server port for SFTP type storage medium
Port float64 `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey string `json:"private_key"`
// Region of the storage medium.
Region string `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret string `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username string `json:"username"`
JSON recordingGetRecordingsResponseDataStorageConfigJSON `json:"-"`
}
func (*RecordingGetRecordingsResponseDataStorageConfig) UnmarshalJSON ¶
func (r *RecordingGetRecordingsResponseDataStorageConfig) UnmarshalJSON(data []byte) (err error)
type RecordingGetRecordingsResponseDataStorageConfigAuthMethod ¶
type RecordingGetRecordingsResponseDataStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( RecordingGetRecordingsResponseDataStorageConfigAuthMethodKey RecordingGetRecordingsResponseDataStorageConfigAuthMethod = "KEY" RecordingGetRecordingsResponseDataStorageConfigAuthMethodPassword RecordingGetRecordingsResponseDataStorageConfigAuthMethod = "PASSWORD" )
func (RecordingGetRecordingsResponseDataStorageConfigAuthMethod) IsKnown ¶
func (r RecordingGetRecordingsResponseDataStorageConfigAuthMethod) IsKnown() bool
type RecordingGetRecordingsResponseDataStorageConfigType ¶
type RecordingGetRecordingsResponseDataStorageConfigType string
Type of storage media.
const ( RecordingGetRecordingsResponseDataStorageConfigTypeAws RecordingGetRecordingsResponseDataStorageConfigType = "aws" RecordingGetRecordingsResponseDataStorageConfigTypeAzure RecordingGetRecordingsResponseDataStorageConfigType = "azure" RecordingGetRecordingsResponseDataStorageConfigTypeDigitalocean RecordingGetRecordingsResponseDataStorageConfigType = "digitalocean" RecordingGetRecordingsResponseDataStorageConfigTypeGcs RecordingGetRecordingsResponseDataStorageConfigType = "gcs" RecordingGetRecordingsResponseDataStorageConfigTypeSftp RecordingGetRecordingsResponseDataStorageConfigType = "sftp" )
func (RecordingGetRecordingsResponseDataStorageConfigType) IsKnown ¶
func (r RecordingGetRecordingsResponseDataStorageConfigType) IsKnown() bool
type RecordingGetRecordingsResponsePaging ¶
type RecordingGetRecordingsResponsePaging struct {
EndOffset float64 `json:"end_offset" api:"required"`
StartOffset float64 `json:"start_offset" api:"required"`
TotalCount float64 `json:"total_count" api:"required"`
JSON recordingGetRecordingsResponsePagingJSON `json:"-"`
}
func (*RecordingGetRecordingsResponsePaging) UnmarshalJSON ¶
func (r *RecordingGetRecordingsResponsePaging) UnmarshalJSON(data []byte) (err error)
type RecordingPauseResumeStopRecordingParams ¶
type RecordingPauseResumeStopRecordingParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
Action param.Field[RecordingPauseResumeStopRecordingParamsAction] `json:"action" api:"required"`
}
func (RecordingPauseResumeStopRecordingParams) MarshalJSON ¶
func (r RecordingPauseResumeStopRecordingParams) MarshalJSON() (data []byte, err error)
type RecordingPauseResumeStopRecordingParamsAction ¶
type RecordingPauseResumeStopRecordingParamsAction string
const ( RecordingPauseResumeStopRecordingParamsActionStop RecordingPauseResumeStopRecordingParamsAction = "stop" RecordingPauseResumeStopRecordingParamsActionPause RecordingPauseResumeStopRecordingParamsAction = "pause" RecordingPauseResumeStopRecordingParamsActionResume RecordingPauseResumeStopRecordingParamsAction = "resume" )
func (RecordingPauseResumeStopRecordingParamsAction) IsKnown ¶
func (r RecordingPauseResumeStopRecordingParamsAction) IsKnown() bool
type RecordingPauseResumeStopRecordingResponse ¶
type RecordingPauseResumeStopRecordingResponse struct {
// Success status of the operation
Success bool `json:"success" api:"required"`
// Data returned by the operation
Data RecordingPauseResumeStopRecordingResponseData `json:"data"`
JSON recordingPauseResumeStopRecordingResponseJSON `json:"-"`
}
func (*RecordingPauseResumeStopRecordingResponse) UnmarshalJSON ¶
func (r *RecordingPauseResumeStopRecordingResponse) UnmarshalJSON(data []byte) (err error)
type RecordingPauseResumeStopRecordingResponseData ¶
type RecordingPauseResumeStopRecordingResponseData struct {
// ID of the recording
ID string `json:"id" api:"required" format:"uuid"`
// If the audio_config is passed, the URL for downloading the audio recording is
// returned.
AudioDownloadURL string `json:"audio_download_url" api:"required,nullable" format:"uri"`
// URL where the recording can be downloaded.
DownloadURL string `json:"download_url" api:"required,nullable" format:"uri"`
// Timestamp when the download URL expires.
DownloadURLExpiry time.Time `json:"download_url_expiry" api:"required,nullable" format:"date-time"`
// File size of the recording, in bytes.
FileSize float64 `json:"file_size" api:"required,nullable"`
// Timestamp when this recording was invoked.
InvokedTime time.Time `json:"invoked_time" api:"required" format:"date-time"`
// File name of the recording.
OutputFileName string `json:"output_file_name" api:"required"`
// ID of the meeting session this recording is for.
SessionID string `json:"session_id" api:"required,nullable" format:"uuid"`
// Timestamp when this recording actually started after being invoked. Usually a
// few seconds after `invoked_time`.
StartedTime time.Time `json:"started_time" api:"required,nullable" format:"date-time"`
// Current status of the recording.
Status RecordingPauseResumeStopRecordingResponseDataStatus `json:"status" api:"required"`
// Timestamp when this recording was stopped. Optional; is present only when the
// recording has actually been stopped.
StoppedTime time.Time `json:"stopped_time" api:"required,nullable" format:"date-time"`
// Total recording time in seconds.
RecordingDuration int64 `json:"recording_duration"`
StartReason RecordingPauseResumeStopRecordingResponseDataStartReason `json:"start_reason"`
StopReason RecordingPauseResumeStopRecordingResponseDataStopReason `json:"stop_reason"`
StorageConfig RecordingPauseResumeStopRecordingResponseDataStorageConfig `json:"storage_config" api:"nullable"`
JSON recordingPauseResumeStopRecordingResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*RecordingPauseResumeStopRecordingResponseData) UnmarshalJSON ¶
func (r *RecordingPauseResumeStopRecordingResponseData) UnmarshalJSON(data []byte) (err error)
type RecordingPauseResumeStopRecordingResponseDataStartReason ¶
type RecordingPauseResumeStopRecordingResponseDataStartReason struct {
Caller RecordingPauseResumeStopRecordingResponseDataStartReasonCaller `json:"caller"`
// Specifies if the recording was started using the "Start a Recording"API or using
// the parameter RECORD_ON_START in the "Create a meeting" API.
//
// If the recording is initiated using the "RECORD_ON_START" parameter, the user
// details will not be populated.
Reason RecordingPauseResumeStopRecordingResponseDataStartReasonReason `json:"reason"`
JSON recordingPauseResumeStopRecordingResponseDataStartReasonJSON `json:"-"`
}
func (*RecordingPauseResumeStopRecordingResponseDataStartReason) UnmarshalJSON ¶
func (r *RecordingPauseResumeStopRecordingResponseDataStartReason) UnmarshalJSON(data []byte) (err error)
type RecordingPauseResumeStopRecordingResponseDataStartReasonCaller ¶
type RecordingPauseResumeStopRecordingResponseDataStartReasonCaller struct {
// Name of the user who started the recording.
Name string `json:"name"`
// The type can be an App or a user. If the type is `user`, then only the `user_Id`
// and `name` are returned.
Type RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType `json:"type"`
// The user ID of the person who started the recording.
UserID string `json:"user_Id" format:"uuid"`
JSON recordingPauseResumeStopRecordingResponseDataStartReasonCallerJSON `json:"-"`
}
func (*RecordingPauseResumeStopRecordingResponseDataStartReasonCaller) UnmarshalJSON ¶
func (r *RecordingPauseResumeStopRecordingResponseDataStartReasonCaller) UnmarshalJSON(data []byte) (err error)
type RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType ¶
type RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType string
The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.
const ( RecordingPauseResumeStopRecordingResponseDataStartReasonCallerTypeOrganization RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType = "ORGANIZATION" RecordingPauseResumeStopRecordingResponseDataStartReasonCallerTypeUser RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType = "USER" )
func (RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType) IsKnown ¶
func (r RecordingPauseResumeStopRecordingResponseDataStartReasonCallerType) IsKnown() bool
type RecordingPauseResumeStopRecordingResponseDataStartReasonReason ¶
type RecordingPauseResumeStopRecordingResponseDataStartReasonReason string
Specifies if the recording was started using the "Start a Recording"API or using the parameter RECORD_ON_START in the "Create a meeting" API.
If the recording is initiated using the "RECORD_ON_START" parameter, the user details will not be populated.
const ( RecordingPauseResumeStopRecordingResponseDataStartReasonReasonAPICall RecordingPauseResumeStopRecordingResponseDataStartReasonReason = "API_CALL" RecordingPauseResumeStopRecordingResponseDataStartReasonReasonRecordOnStart RecordingPauseResumeStopRecordingResponseDataStartReasonReason = "RECORD_ON_START" )
func (RecordingPauseResumeStopRecordingResponseDataStartReasonReason) IsKnown ¶
func (r RecordingPauseResumeStopRecordingResponseDataStartReasonReason) IsKnown() bool
type RecordingPauseResumeStopRecordingResponseDataStatus ¶
type RecordingPauseResumeStopRecordingResponseDataStatus string
Current status of the recording.
const ( RecordingPauseResumeStopRecordingResponseDataStatusInvoked RecordingPauseResumeStopRecordingResponseDataStatus = "INVOKED" RecordingPauseResumeStopRecordingResponseDataStatusRecording RecordingPauseResumeStopRecordingResponseDataStatus = "RECORDING" RecordingPauseResumeStopRecordingResponseDataStatusUploading RecordingPauseResumeStopRecordingResponseDataStatus = "UPLOADING" RecordingPauseResumeStopRecordingResponseDataStatusUploaded RecordingPauseResumeStopRecordingResponseDataStatus = "UPLOADED" RecordingPauseResumeStopRecordingResponseDataStatusErrored RecordingPauseResumeStopRecordingResponseDataStatus = "ERRORED" RecordingPauseResumeStopRecordingResponseDataStatusPaused RecordingPauseResumeStopRecordingResponseDataStatus = "PAUSED" )
func (RecordingPauseResumeStopRecordingResponseDataStatus) IsKnown ¶
func (r RecordingPauseResumeStopRecordingResponseDataStatus) IsKnown() bool
type RecordingPauseResumeStopRecordingResponseDataStopReason ¶
type RecordingPauseResumeStopRecordingResponseDataStopReason struct {
Caller RecordingPauseResumeStopRecordingResponseDataStopReasonCaller `json:"caller"`
// Specifies the reason why the recording stopped.
Reason RecordingPauseResumeStopRecordingResponseDataStopReasonReason `json:"reason"`
JSON recordingPauseResumeStopRecordingResponseDataStopReasonJSON `json:"-"`
}
func (*RecordingPauseResumeStopRecordingResponseDataStopReason) UnmarshalJSON ¶
func (r *RecordingPauseResumeStopRecordingResponseDataStopReason) UnmarshalJSON(data []byte) (err error)
type RecordingPauseResumeStopRecordingResponseDataStopReasonCaller ¶
type RecordingPauseResumeStopRecordingResponseDataStopReasonCaller struct {
// Name of the user who stopped the recording.
Name string `json:"name"`
// The type can be an App or a user. If the type is `user`, then only the `user_Id`
// and `name` are returned.
Type RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType `json:"type"`
// The user ID of the person who stopped the recording.
UserID string `json:"user_Id" format:"uuid"`
JSON recordingPauseResumeStopRecordingResponseDataStopReasonCallerJSON `json:"-"`
}
func (*RecordingPauseResumeStopRecordingResponseDataStopReasonCaller) UnmarshalJSON ¶
func (r *RecordingPauseResumeStopRecordingResponseDataStopReasonCaller) UnmarshalJSON(data []byte) (err error)
type RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType ¶
type RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType string
The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.
const ( RecordingPauseResumeStopRecordingResponseDataStopReasonCallerTypeOrganization RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType = "ORGANIZATION" RecordingPauseResumeStopRecordingResponseDataStopReasonCallerTypeUser RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType = "USER" )
func (RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType) IsKnown ¶
func (r RecordingPauseResumeStopRecordingResponseDataStopReasonCallerType) IsKnown() bool
type RecordingPauseResumeStopRecordingResponseDataStopReasonReason ¶
type RecordingPauseResumeStopRecordingResponseDataStopReasonReason string
Specifies the reason why the recording stopped.
const ( RecordingPauseResumeStopRecordingResponseDataStopReasonReasonAPICall RecordingPauseResumeStopRecordingResponseDataStopReasonReason = "API_CALL" RecordingPauseResumeStopRecordingResponseDataStopReasonReasonInternalError RecordingPauseResumeStopRecordingResponseDataStopReasonReason = "INTERNAL_ERROR" RecordingPauseResumeStopRecordingResponseDataStopReasonReasonAllPeersLeft RecordingPauseResumeStopRecordingResponseDataStopReasonReason = "ALL_PEERS_LEFT" )
func (RecordingPauseResumeStopRecordingResponseDataStopReasonReason) IsKnown ¶
func (r RecordingPauseResumeStopRecordingResponseDataStopReasonReason) IsKnown() bool
type RecordingPauseResumeStopRecordingResponseDataStorageConfig ¶
type RecordingPauseResumeStopRecordingResponseDataStorageConfig struct {
// Type of storage media.
Type RecordingPauseResumeStopRecordingResponseDataStorageConfigType `json:"type" api:"required"`
// Authentication method used for "sftp" type storage medium
AuthMethod RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket string `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host string `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password string `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path string `json:"path"`
// SSH destination server port for SFTP type storage medium
Port float64 `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey string `json:"private_key"`
// Region of the storage medium.
Region string `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret string `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username string `json:"username"`
JSON recordingPauseResumeStopRecordingResponseDataStorageConfigJSON `json:"-"`
}
func (*RecordingPauseResumeStopRecordingResponseDataStorageConfig) UnmarshalJSON ¶
func (r *RecordingPauseResumeStopRecordingResponseDataStorageConfig) UnmarshalJSON(data []byte) (err error)
type RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod ¶
type RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethodKey RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod = "KEY" RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethodPassword RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod = "PASSWORD" )
func (RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod) IsKnown ¶
func (r RecordingPauseResumeStopRecordingResponseDataStorageConfigAuthMethod) IsKnown() bool
type RecordingPauseResumeStopRecordingResponseDataStorageConfigType ¶
type RecordingPauseResumeStopRecordingResponseDataStorageConfigType string
Type of storage media.
const ( RecordingPauseResumeStopRecordingResponseDataStorageConfigTypeAws RecordingPauseResumeStopRecordingResponseDataStorageConfigType = "aws" RecordingPauseResumeStopRecordingResponseDataStorageConfigTypeAzure RecordingPauseResumeStopRecordingResponseDataStorageConfigType = "azure" RecordingPauseResumeStopRecordingResponseDataStorageConfigTypeDigitalocean RecordingPauseResumeStopRecordingResponseDataStorageConfigType = "digitalocean" RecordingPauseResumeStopRecordingResponseDataStorageConfigTypeGcs RecordingPauseResumeStopRecordingResponseDataStorageConfigType = "gcs" RecordingPauseResumeStopRecordingResponseDataStorageConfigTypeSftp RecordingPauseResumeStopRecordingResponseDataStorageConfigType = "sftp" )
func (RecordingPauseResumeStopRecordingResponseDataStorageConfigType) IsKnown ¶
func (r RecordingPauseResumeStopRecordingResponseDataStorageConfigType) IsKnown() bool
type RecordingService ¶
type RecordingService struct {
Options []option.RequestOption
}
RecordingService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRecordingService method instead.
func NewRecordingService ¶
func NewRecordingService(opts ...option.RequestOption) (r *RecordingService)
NewRecordingService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*RecordingService) GetActiveRecordings ¶
func (r *RecordingService) GetActiveRecordings(ctx context.Context, appID string, meetingID string, query RecordingGetActiveRecordingsParams, opts ...option.RequestOption) (res *RecordingGetActiveRecordingsResponse, err error)
Returns the active recording details for the given meeting ID.
func (*RecordingService) GetOneRecording ¶
func (r *RecordingService) GetOneRecording(ctx context.Context, appID string, recordingID string, query RecordingGetOneRecordingParams, opts ...option.RequestOption) (res *RecordingGetOneRecordingResponse, err error)
Returns details of a recording for the given recording ID.
func (*RecordingService) GetRecordings ¶
func (r *RecordingService) GetRecordings(ctx context.Context, appID string, params RecordingGetRecordingsParams, opts ...option.RequestOption) (res *RecordingGetRecordingsResponse, err error)
Returns all recordings for an App. If the `meeting_id` parameter is passed, returns all recordings for the given meeting ID.
func (*RecordingService) PauseResumeStopRecording ¶
func (r *RecordingService) PauseResumeStopRecording(ctx context.Context, appID string, recordingID string, params RecordingPauseResumeStopRecordingParams, opts ...option.RequestOption) (res *RecordingPauseResumeStopRecordingResponse, err error)
Pause/Resume/Stop a given recording ID.
func (*RecordingService) StartRecordings ¶
func (r *RecordingService) StartRecordings(ctx context.Context, appID string, params RecordingStartRecordingsParams, opts ...option.RequestOption) (res *RecordingStartRecordingsResponse, err error)
Starts recording a meeting. The meeting can be started by an App admin directly, or a participant with permissions to start a recording, based on the type of authorization used.
func (*RecordingService) StartTrackRecording ¶
func (r *RecordingService) StartTrackRecording(ctx context.Context, appID string, params RecordingStartTrackRecordingParams, opts ...option.RequestOption) (err error)
Starts a track recording in a meeting. Track recordings consist of "layers". Layers are used to map audio/video tracks in a meeting to output destinations. More information about track recordings is available in the [Track Recordings Guide Page](https://docs.realtime.cloudflare.com/guides/capabilities/recording/recording-overview).
type RecordingStartRecordingsParams ¶
type RecordingStartRecordingsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// By default, a meeting allows only one recording to run at a time. Enabling the
// `allow_multiple_recordings` parameter to true allows you to initiate multiple
// recordings concurrently in the same meeting. This allows you to record separate
// videos of the same meeting with different configurations, such as portrait mode
// or landscape mode.
AllowMultipleRecordings param.Field[bool] `json:"allow_multiple_recordings"`
// Object containing configuration regarding the audio that is being recorded.
AudioConfig param.Field[RecordingStartRecordingsParamsAudioConfig] `json:"audio_config"`
// Update the recording file name.
FileNamePrefix param.Field[string] `json:"file_name_prefix"`
// Allows you to add timed metadata to your recordings, which are digital markers
// inserted into a video file to provide contextual information at specific points
// in the content range. The ID3 tags containing this information are available to
// clients on the playback timeline in HLS format. The output files are generated
// in a compressed .tar format.
InteractiveConfig param.Field[RecordingStartRecordingsParamsInteractiveConfig] `json:"interactive_config"`
// Specifies the maximum duration for recording in seconds, ranging from a minimum
// of 60 seconds to a maximum of 24 hours.
MaxSeconds param.Field[int64] `json:"max_seconds"`
// ID of the meeting to record.
MeetingID param.Field[string] `json:"meeting_id" format:"uuid"`
RealtimekitBucketConfig param.Field[RecordingStartRecordingsParamsRealtimekitBucketConfig] `json:"realtimekit_bucket_config"`
RtmpOutConfig param.Field[RecordingStartRecordingsParamsRtmpOutConfig] `json:"rtmp_out_config"`
StorageConfig param.Field[RecordingStartRecordingsParamsStorageConfig] `json:"storage_config"`
// Pass a custom url to record arbitary screen
URL param.Field[string] `json:"url" format:"uri"`
VideoConfig param.Field[RecordingStartRecordingsParamsVideoConfig] `json:"video_config"`
}
func (RecordingStartRecordingsParams) MarshalJSON ¶
func (r RecordingStartRecordingsParams) MarshalJSON() (data []byte, err error)
type RecordingStartRecordingsParamsAudioConfig ¶
type RecordingStartRecordingsParamsAudioConfig struct {
// Audio signal pathway within an audio file that carries a specific sound source.
Channel param.Field[RecordingStartRecordingsParamsAudioConfigChannel] `json:"channel"`
// Codec using which the recording will be encoded. If VP8/VP9 is selected for
// videoConfig, changing audioConfig is not allowed. In this case, the codec in the
// audioConfig is automatically set to vorbis.
Codec param.Field[RecordingStartRecordingsParamsAudioConfigCodec] `json:"codec"`
// Controls whether to export audio file seperately
ExportFile param.Field[bool] `json:"export_file"`
}
Object containing configuration regarding the audio that is being recorded.
func (RecordingStartRecordingsParamsAudioConfig) MarshalJSON ¶
func (r RecordingStartRecordingsParamsAudioConfig) MarshalJSON() (data []byte, err error)
type RecordingStartRecordingsParamsAudioConfigChannel ¶
type RecordingStartRecordingsParamsAudioConfigChannel string
Audio signal pathway within an audio file that carries a specific sound source.
const ( RecordingStartRecordingsParamsAudioConfigChannelMono RecordingStartRecordingsParamsAudioConfigChannel = "mono" RecordingStartRecordingsParamsAudioConfigChannelStereo RecordingStartRecordingsParamsAudioConfigChannel = "stereo" )
func (RecordingStartRecordingsParamsAudioConfigChannel) IsKnown ¶
func (r RecordingStartRecordingsParamsAudioConfigChannel) IsKnown() bool
type RecordingStartRecordingsParamsAudioConfigCodec ¶
type RecordingStartRecordingsParamsAudioConfigCodec string
Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.
const ( RecordingStartRecordingsParamsAudioConfigCodecMP3 RecordingStartRecordingsParamsAudioConfigCodec = "MP3" RecordingStartRecordingsParamsAudioConfigCodecAac RecordingStartRecordingsParamsAudioConfigCodec = "AAC" )
func (RecordingStartRecordingsParamsAudioConfigCodec) IsKnown ¶
func (r RecordingStartRecordingsParamsAudioConfigCodec) IsKnown() bool
type RecordingStartRecordingsParamsInteractiveConfig ¶
type RecordingStartRecordingsParamsInteractiveConfig struct {
// The metadata is presented in the form of ID3 tags.
Type param.Field[RecordingStartRecordingsParamsInteractiveConfigType] `json:"type"`
}
Allows you to add timed metadata to your recordings, which are digital markers inserted into a video file to provide contextual information at specific points in the content range. The ID3 tags containing this information are available to clients on the playback timeline in HLS format. The output files are generated in a compressed .tar format.
func (RecordingStartRecordingsParamsInteractiveConfig) MarshalJSON ¶
func (r RecordingStartRecordingsParamsInteractiveConfig) MarshalJSON() (data []byte, err error)
type RecordingStartRecordingsParamsInteractiveConfigType ¶
type RecordingStartRecordingsParamsInteractiveConfigType string
The metadata is presented in the form of ID3 tags.
const (
RecordingStartRecordingsParamsInteractiveConfigTypeId3 RecordingStartRecordingsParamsInteractiveConfigType = "ID3"
)
func (RecordingStartRecordingsParamsInteractiveConfigType) IsKnown ¶
func (r RecordingStartRecordingsParamsInteractiveConfigType) IsKnown() bool
type RecordingStartRecordingsParamsRealtimekitBucketConfig ¶
type RecordingStartRecordingsParamsRealtimekitBucketConfig struct {
// Controls whether recordings are uploaded to RealtimeKit's bucket. If set to
// false, `download_url`, `audio_download_url`, `download_url_expiry` won't be
// generated for a recording.
Enabled param.Field[bool] `json:"enabled" api:"required"`
}
func (RecordingStartRecordingsParamsRealtimekitBucketConfig) MarshalJSON ¶
func (r RecordingStartRecordingsParamsRealtimekitBucketConfig) MarshalJSON() (data []byte, err error)
type RecordingStartRecordingsParamsRtmpOutConfig ¶
type RecordingStartRecordingsParamsRtmpOutConfig struct {
// RTMP URL to stream to
RtmpURL param.Field[string] `json:"rtmp_url" format:"uri"`
}
func (RecordingStartRecordingsParamsRtmpOutConfig) MarshalJSON ¶
func (r RecordingStartRecordingsParamsRtmpOutConfig) MarshalJSON() (data []byte, err error)
type RecordingStartRecordingsParamsStorageConfig ¶
type RecordingStartRecordingsParamsStorageConfig struct {
// Type of storage media.
Type param.Field[RecordingStartRecordingsParamsStorageConfigType] `json:"type" api:"required"`
// Access key of the storage medium. Access key is not required for the `gcs`
// storage media type.
//
// Note that this field is not readable by clients, only writeable.
AccessKey param.Field[string] `json:"access_key"`
// Authentication method used for "sftp" type storage medium
AuthMethod param.Field[RecordingStartRecordingsParamsStorageConfigAuthMethod] `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket param.Field[string] `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host param.Field[string] `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password param.Field[string] `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path param.Field[string] `json:"path"`
// SSH destination server port for SFTP type storage medium
Port param.Field[float64] `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey param.Field[string] `json:"private_key"`
// Region of the storage medium.
Region param.Field[string] `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret param.Field[string] `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username param.Field[string] `json:"username"`
}
func (RecordingStartRecordingsParamsStorageConfig) MarshalJSON ¶
func (r RecordingStartRecordingsParamsStorageConfig) MarshalJSON() (data []byte, err error)
type RecordingStartRecordingsParamsStorageConfigAuthMethod ¶
type RecordingStartRecordingsParamsStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( RecordingStartRecordingsParamsStorageConfigAuthMethodKey RecordingStartRecordingsParamsStorageConfigAuthMethod = "KEY" RecordingStartRecordingsParamsStorageConfigAuthMethodPassword RecordingStartRecordingsParamsStorageConfigAuthMethod = "PASSWORD" )
func (RecordingStartRecordingsParamsStorageConfigAuthMethod) IsKnown ¶
func (r RecordingStartRecordingsParamsStorageConfigAuthMethod) IsKnown() bool
type RecordingStartRecordingsParamsStorageConfigType ¶
type RecordingStartRecordingsParamsStorageConfigType string
Type of storage media.
const ( RecordingStartRecordingsParamsStorageConfigTypeAws RecordingStartRecordingsParamsStorageConfigType = "aws" RecordingStartRecordingsParamsStorageConfigTypeAzure RecordingStartRecordingsParamsStorageConfigType = "azure" RecordingStartRecordingsParamsStorageConfigTypeDigitalocean RecordingStartRecordingsParamsStorageConfigType = "digitalocean" RecordingStartRecordingsParamsStorageConfigTypeGcs RecordingStartRecordingsParamsStorageConfigType = "gcs" RecordingStartRecordingsParamsStorageConfigTypeSftp RecordingStartRecordingsParamsStorageConfigType = "sftp" )
func (RecordingStartRecordingsParamsStorageConfigType) IsKnown ¶
func (r RecordingStartRecordingsParamsStorageConfigType) IsKnown() bool
type RecordingStartRecordingsParamsVideoConfig ¶
type RecordingStartRecordingsParamsVideoConfig struct {
// Codec using which the recording will be encoded.
Codec param.Field[RecordingStartRecordingsParamsVideoConfigCodec] `json:"codec"`
// Controls whether to export video file seperately
ExportFile param.Field[bool] `json:"export_file"`
// Height of the recording video in pixels
Height param.Field[int64] `json:"height"`
// Watermark to be added to the recording
Watermark param.Field[RecordingStartRecordingsParamsVideoConfigWatermark] `json:"watermark"`
// Width of the recording video in pixels
Width param.Field[int64] `json:"width"`
}
func (RecordingStartRecordingsParamsVideoConfig) MarshalJSON ¶
func (r RecordingStartRecordingsParamsVideoConfig) MarshalJSON() (data []byte, err error)
type RecordingStartRecordingsParamsVideoConfigCodec ¶
type RecordingStartRecordingsParamsVideoConfigCodec string
Codec using which the recording will be encoded.
const ( RecordingStartRecordingsParamsVideoConfigCodecH264 RecordingStartRecordingsParamsVideoConfigCodec = "H264" RecordingStartRecordingsParamsVideoConfigCodecVp8 RecordingStartRecordingsParamsVideoConfigCodec = "VP8" )
func (RecordingStartRecordingsParamsVideoConfigCodec) IsKnown ¶
func (r RecordingStartRecordingsParamsVideoConfigCodec) IsKnown() bool
type RecordingStartRecordingsParamsVideoConfigWatermark ¶
type RecordingStartRecordingsParamsVideoConfigWatermark struct {
// Position of the watermark
Position param.Field[RecordingStartRecordingsParamsVideoConfigWatermarkPosition] `json:"position"`
// Size of the watermark
Size param.Field[RecordingStartRecordingsParamsVideoConfigWatermarkSize] `json:"size"`
// URL of the watermark image
URL param.Field[string] `json:"url" format:"uri"`
}
Watermark to be added to the recording
func (RecordingStartRecordingsParamsVideoConfigWatermark) MarshalJSON ¶
func (r RecordingStartRecordingsParamsVideoConfigWatermark) MarshalJSON() (data []byte, err error)
type RecordingStartRecordingsParamsVideoConfigWatermarkPosition ¶
type RecordingStartRecordingsParamsVideoConfigWatermarkPosition string
Position of the watermark
const ( RecordingStartRecordingsParamsVideoConfigWatermarkPositionLeftTop RecordingStartRecordingsParamsVideoConfigWatermarkPosition = "left top" RecordingStartRecordingsParamsVideoConfigWatermarkPositionRightTop RecordingStartRecordingsParamsVideoConfigWatermarkPosition = "right top" RecordingStartRecordingsParamsVideoConfigWatermarkPositionLeftBottom RecordingStartRecordingsParamsVideoConfigWatermarkPosition = "left bottom" RecordingStartRecordingsParamsVideoConfigWatermarkPositionRightBottom RecordingStartRecordingsParamsVideoConfigWatermarkPosition = "right bottom" )
func (RecordingStartRecordingsParamsVideoConfigWatermarkPosition) IsKnown ¶
func (r RecordingStartRecordingsParamsVideoConfigWatermarkPosition) IsKnown() bool
type RecordingStartRecordingsParamsVideoConfigWatermarkSize ¶
type RecordingStartRecordingsParamsVideoConfigWatermarkSize struct {
// Height of the watermark in px
Height param.Field[int64] `json:"height"`
// Width of the watermark in px
Width param.Field[int64] `json:"width"`
}
Size of the watermark
func (RecordingStartRecordingsParamsVideoConfigWatermarkSize) MarshalJSON ¶
func (r RecordingStartRecordingsParamsVideoConfigWatermarkSize) MarshalJSON() (data []byte, err error)
type RecordingStartRecordingsResponse ¶
type RecordingStartRecordingsResponse struct {
// Success status of the operation
Success bool `json:"success" api:"required"`
// Data returned by the operation
Data RecordingStartRecordingsResponseData `json:"data"`
JSON recordingStartRecordingsResponseJSON `json:"-"`
}
func (*RecordingStartRecordingsResponse) UnmarshalJSON ¶
func (r *RecordingStartRecordingsResponse) UnmarshalJSON(data []byte) (err error)
type RecordingStartRecordingsResponseData ¶
type RecordingStartRecordingsResponseData struct {
// ID of the recording
ID string `json:"id" api:"required" format:"uuid"`
// If the audio_config is passed, the URL for downloading the audio recording is
// returned.
AudioDownloadURL string `json:"audio_download_url" api:"required,nullable" format:"uri"`
// URL where the recording can be downloaded.
DownloadURL string `json:"download_url" api:"required,nullable" format:"uri"`
// Timestamp when the download URL expires.
DownloadURLExpiry time.Time `json:"download_url_expiry" api:"required,nullable" format:"date-time"`
// File size of the recording, in bytes.
FileSize float64 `json:"file_size" api:"required,nullable"`
// Timestamp when this recording was invoked.
InvokedTime time.Time `json:"invoked_time" api:"required" format:"date-time"`
// File name of the recording.
OutputFileName string `json:"output_file_name" api:"required"`
// ID of the meeting session this recording is for.
SessionID string `json:"session_id" api:"required,nullable" format:"uuid"`
// Timestamp when this recording actually started after being invoked. Usually a
// few seconds after `invoked_time`.
StartedTime time.Time `json:"started_time" api:"required,nullable" format:"date-time"`
// Current status of the recording.
Status RecordingStartRecordingsResponseDataStatus `json:"status" api:"required"`
// Timestamp when this recording was stopped. Optional; is present only when the
// recording has actually been stopped.
StoppedTime time.Time `json:"stopped_time" api:"required,nullable" format:"date-time"`
// Total recording time in seconds.
RecordingDuration int64 `json:"recording_duration"`
StartReason RecordingStartRecordingsResponseDataStartReason `json:"start_reason"`
StopReason RecordingStartRecordingsResponseDataStopReason `json:"stop_reason"`
StorageConfig RecordingStartRecordingsResponseDataStorageConfig `json:"storage_config" api:"nullable"`
JSON recordingStartRecordingsResponseDataJSON `json:"-"`
}
Data returned by the operation
func (*RecordingStartRecordingsResponseData) UnmarshalJSON ¶
func (r *RecordingStartRecordingsResponseData) UnmarshalJSON(data []byte) (err error)
type RecordingStartRecordingsResponseDataStartReason ¶
type RecordingStartRecordingsResponseDataStartReason struct {
Caller RecordingStartRecordingsResponseDataStartReasonCaller `json:"caller"`
// Specifies if the recording was started using the "Start a Recording"API or using
// the parameter RECORD_ON_START in the "Create a meeting" API.
//
// If the recording is initiated using the "RECORD_ON_START" parameter, the user
// details will not be populated.
Reason RecordingStartRecordingsResponseDataStartReasonReason `json:"reason"`
JSON recordingStartRecordingsResponseDataStartReasonJSON `json:"-"`
}
func (*RecordingStartRecordingsResponseDataStartReason) UnmarshalJSON ¶
func (r *RecordingStartRecordingsResponseDataStartReason) UnmarshalJSON(data []byte) (err error)
type RecordingStartRecordingsResponseDataStartReasonCaller ¶
type RecordingStartRecordingsResponseDataStartReasonCaller struct {
// Name of the user who started the recording.
Name string `json:"name"`
// The type can be an App or a user. If the type is `user`, then only the `user_Id`
// and `name` are returned.
Type RecordingStartRecordingsResponseDataStartReasonCallerType `json:"type"`
// The user ID of the person who started the recording.
UserID string `json:"user_Id" format:"uuid"`
JSON recordingStartRecordingsResponseDataStartReasonCallerJSON `json:"-"`
}
func (*RecordingStartRecordingsResponseDataStartReasonCaller) UnmarshalJSON ¶
func (r *RecordingStartRecordingsResponseDataStartReasonCaller) UnmarshalJSON(data []byte) (err error)
type RecordingStartRecordingsResponseDataStartReasonCallerType ¶
type RecordingStartRecordingsResponseDataStartReasonCallerType string
The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.
const ( RecordingStartRecordingsResponseDataStartReasonCallerTypeOrganization RecordingStartRecordingsResponseDataStartReasonCallerType = "ORGANIZATION" RecordingStartRecordingsResponseDataStartReasonCallerTypeUser RecordingStartRecordingsResponseDataStartReasonCallerType = "USER" )
func (RecordingStartRecordingsResponseDataStartReasonCallerType) IsKnown ¶
func (r RecordingStartRecordingsResponseDataStartReasonCallerType) IsKnown() bool
type RecordingStartRecordingsResponseDataStartReasonReason ¶
type RecordingStartRecordingsResponseDataStartReasonReason string
Specifies if the recording was started using the "Start a Recording"API or using the parameter RECORD_ON_START in the "Create a meeting" API.
If the recording is initiated using the "RECORD_ON_START" parameter, the user details will not be populated.
const ( RecordingStartRecordingsResponseDataStartReasonReasonAPICall RecordingStartRecordingsResponseDataStartReasonReason = "API_CALL" RecordingStartRecordingsResponseDataStartReasonReasonRecordOnStart RecordingStartRecordingsResponseDataStartReasonReason = "RECORD_ON_START" )
func (RecordingStartRecordingsResponseDataStartReasonReason) IsKnown ¶
func (r RecordingStartRecordingsResponseDataStartReasonReason) IsKnown() bool
type RecordingStartRecordingsResponseDataStatus ¶
type RecordingStartRecordingsResponseDataStatus string
Current status of the recording.
const ( RecordingStartRecordingsResponseDataStatusInvoked RecordingStartRecordingsResponseDataStatus = "INVOKED" RecordingStartRecordingsResponseDataStatusRecording RecordingStartRecordingsResponseDataStatus = "RECORDING" RecordingStartRecordingsResponseDataStatusUploading RecordingStartRecordingsResponseDataStatus = "UPLOADING" RecordingStartRecordingsResponseDataStatusUploaded RecordingStartRecordingsResponseDataStatus = "UPLOADED" RecordingStartRecordingsResponseDataStatusErrored RecordingStartRecordingsResponseDataStatus = "ERRORED" RecordingStartRecordingsResponseDataStatusPaused RecordingStartRecordingsResponseDataStatus = "PAUSED" )
func (RecordingStartRecordingsResponseDataStatus) IsKnown ¶
func (r RecordingStartRecordingsResponseDataStatus) IsKnown() bool
type RecordingStartRecordingsResponseDataStopReason ¶
type RecordingStartRecordingsResponseDataStopReason struct {
Caller RecordingStartRecordingsResponseDataStopReasonCaller `json:"caller"`
// Specifies the reason why the recording stopped.
Reason RecordingStartRecordingsResponseDataStopReasonReason `json:"reason"`
JSON recordingStartRecordingsResponseDataStopReasonJSON `json:"-"`
}
func (*RecordingStartRecordingsResponseDataStopReason) UnmarshalJSON ¶
func (r *RecordingStartRecordingsResponseDataStopReason) UnmarshalJSON(data []byte) (err error)
type RecordingStartRecordingsResponseDataStopReasonCaller ¶
type RecordingStartRecordingsResponseDataStopReasonCaller struct {
// Name of the user who stopped the recording.
Name string `json:"name"`
// The type can be an App or a user. If the type is `user`, then only the `user_Id`
// and `name` are returned.
Type RecordingStartRecordingsResponseDataStopReasonCallerType `json:"type"`
// The user ID of the person who stopped the recording.
UserID string `json:"user_Id" format:"uuid"`
JSON recordingStartRecordingsResponseDataStopReasonCallerJSON `json:"-"`
}
func (*RecordingStartRecordingsResponseDataStopReasonCaller) UnmarshalJSON ¶
func (r *RecordingStartRecordingsResponseDataStopReasonCaller) UnmarshalJSON(data []byte) (err error)
type RecordingStartRecordingsResponseDataStopReasonCallerType ¶
type RecordingStartRecordingsResponseDataStopReasonCallerType string
The type can be an App or a user. If the type is `user`, then only the `user_Id` and `name` are returned.
const ( RecordingStartRecordingsResponseDataStopReasonCallerTypeOrganization RecordingStartRecordingsResponseDataStopReasonCallerType = "ORGANIZATION" RecordingStartRecordingsResponseDataStopReasonCallerTypeUser RecordingStartRecordingsResponseDataStopReasonCallerType = "USER" )
func (RecordingStartRecordingsResponseDataStopReasonCallerType) IsKnown ¶
func (r RecordingStartRecordingsResponseDataStopReasonCallerType) IsKnown() bool
type RecordingStartRecordingsResponseDataStopReasonReason ¶
type RecordingStartRecordingsResponseDataStopReasonReason string
Specifies the reason why the recording stopped.
const ( RecordingStartRecordingsResponseDataStopReasonReasonAPICall RecordingStartRecordingsResponseDataStopReasonReason = "API_CALL" RecordingStartRecordingsResponseDataStopReasonReasonInternalError RecordingStartRecordingsResponseDataStopReasonReason = "INTERNAL_ERROR" RecordingStartRecordingsResponseDataStopReasonReasonAllPeersLeft RecordingStartRecordingsResponseDataStopReasonReason = "ALL_PEERS_LEFT" )
func (RecordingStartRecordingsResponseDataStopReasonReason) IsKnown ¶
func (r RecordingStartRecordingsResponseDataStopReasonReason) IsKnown() bool
type RecordingStartRecordingsResponseDataStorageConfig ¶
type RecordingStartRecordingsResponseDataStorageConfig struct {
// Type of storage media.
Type RecordingStartRecordingsResponseDataStorageConfigType `json:"type" api:"required"`
// Authentication method used for "sftp" type storage medium
AuthMethod RecordingStartRecordingsResponseDataStorageConfigAuthMethod `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket string `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host string `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password string `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path string `json:"path"`
// SSH destination server port for SFTP type storage medium
Port float64 `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey string `json:"private_key"`
// Region of the storage medium.
Region string `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret string `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username string `json:"username"`
JSON recordingStartRecordingsResponseDataStorageConfigJSON `json:"-"`
}
func (*RecordingStartRecordingsResponseDataStorageConfig) UnmarshalJSON ¶
func (r *RecordingStartRecordingsResponseDataStorageConfig) UnmarshalJSON(data []byte) (err error)
type RecordingStartRecordingsResponseDataStorageConfigAuthMethod ¶
type RecordingStartRecordingsResponseDataStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( RecordingStartRecordingsResponseDataStorageConfigAuthMethodKey RecordingStartRecordingsResponseDataStorageConfigAuthMethod = "KEY" RecordingStartRecordingsResponseDataStorageConfigAuthMethodPassword RecordingStartRecordingsResponseDataStorageConfigAuthMethod = "PASSWORD" )
func (RecordingStartRecordingsResponseDataStorageConfigAuthMethod) IsKnown ¶
func (r RecordingStartRecordingsResponseDataStorageConfigAuthMethod) IsKnown() bool
type RecordingStartRecordingsResponseDataStorageConfigType ¶
type RecordingStartRecordingsResponseDataStorageConfigType string
Type of storage media.
const ( RecordingStartRecordingsResponseDataStorageConfigTypeAws RecordingStartRecordingsResponseDataStorageConfigType = "aws" RecordingStartRecordingsResponseDataStorageConfigTypeAzure RecordingStartRecordingsResponseDataStorageConfigType = "azure" RecordingStartRecordingsResponseDataStorageConfigTypeDigitalocean RecordingStartRecordingsResponseDataStorageConfigType = "digitalocean" RecordingStartRecordingsResponseDataStorageConfigTypeGcs RecordingStartRecordingsResponseDataStorageConfigType = "gcs" RecordingStartRecordingsResponseDataStorageConfigTypeSftp RecordingStartRecordingsResponseDataStorageConfigType = "sftp" )
func (RecordingStartRecordingsResponseDataStorageConfigType) IsKnown ¶
func (r RecordingStartRecordingsResponseDataStorageConfigType) IsKnown() bool
type RecordingStartTrackRecordingParams ¶
type RecordingStartTrackRecordingParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
Layers param.Field[map[string]RecordingStartTrackRecordingParamsLayers] `json:"layers" api:"required"`
// ID of the meeting to record.
MeetingID param.Field[string] `json:"meeting_id" api:"required"`
// Maximum seconds this recording should be active for (beta)
MaxSeconds param.Field[float64] `json:"max_seconds"`
}
func (RecordingStartTrackRecordingParams) MarshalJSON ¶
func (r RecordingStartTrackRecordingParams) MarshalJSON() (data []byte, err error)
type RecordingStartTrackRecordingParamsLayers ¶
type RecordingStartTrackRecordingParamsLayers struct {
// A file name prefix to apply for files generated from this layer
FileNamePrefix param.Field[string] `json:"file_name_prefix"`
Outputs param.Field[[]RecordingStartTrackRecordingParamsLayersOutput] `json:"outputs"`
}
func (RecordingStartTrackRecordingParamsLayers) MarshalJSON ¶
func (r RecordingStartTrackRecordingParamsLayers) MarshalJSON() (data []byte, err error)
type RecordingStartTrackRecordingParamsLayersOutput ¶
type RecordingStartTrackRecordingParamsLayersOutput struct {
StorageConfig param.Field[RecordingStartTrackRecordingParamsLayersOutputsStorageConfig] `json:"storage_config"`
// The type of output destination this layer is being exported to.
Type param.Field[RecordingStartTrackRecordingParamsLayersOutputsType] `json:"type"`
}
func (RecordingStartTrackRecordingParamsLayersOutput) MarshalJSON ¶
func (r RecordingStartTrackRecordingParamsLayersOutput) MarshalJSON() (data []byte, err error)
type RecordingStartTrackRecordingParamsLayersOutputsStorageConfig ¶
type RecordingStartTrackRecordingParamsLayersOutputsStorageConfig struct {
// Type of storage media.
Type param.Field[RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType] `json:"type" api:"required"`
// Access key of the storage medium. Access key is not required for the `gcs`
// storage media type.
//
// Note that this field is not readable by clients, only writeable.
AccessKey param.Field[string] `json:"access_key"`
// Authentication method used for "sftp" type storage medium
AuthMethod param.Field[RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod] `json:"auth_method"`
// Name of the storage medium's bucket.
Bucket param.Field[string] `json:"bucket"`
// SSH destination server host for SFTP type storage medium
Host param.Field[string] `json:"host"`
// SSH destination server password for SFTP type storage medium when auth_method is
// "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh
// private key.
Password param.Field[string] `json:"password"`
// Path relative to the bucket root at which the recording will be placed.
Path param.Field[string] `json:"path"`
// SSH destination server port for SFTP type storage medium
Port param.Field[float64] `json:"port"`
// Private key used to login to destination SSH server for SFTP type storage
// medium, when auth_method used is "KEY"
PrivateKey param.Field[string] `json:"private_key"`
// Region of the storage medium.
Region param.Field[string] `json:"region"`
// Secret key of the storage medium. Similar to `access_key`, it is only writeable
// by clients, not readable.
Secret param.Field[string] `json:"secret"`
// SSH destination server username for SFTP type storage medium
Username param.Field[string] `json:"username"`
}
func (RecordingStartTrackRecordingParamsLayersOutputsStorageConfig) MarshalJSON ¶
func (r RecordingStartTrackRecordingParamsLayersOutputsStorageConfig) MarshalJSON() (data []byte, err error)
type RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod ¶
type RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod string
Authentication method used for "sftp" type storage medium
const ( RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethodKey RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod = "KEY" RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethodPassword RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod = "PASSWORD" )
func (RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod) IsKnown ¶
func (r RecordingStartTrackRecordingParamsLayersOutputsStorageConfigAuthMethod) IsKnown() bool
type RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType ¶
type RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType string
Type of storage media.
const ( RecordingStartTrackRecordingParamsLayersOutputsStorageConfigTypeAws RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType = "aws" RecordingStartTrackRecordingParamsLayersOutputsStorageConfigTypeAzure RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType = "azure" RecordingStartTrackRecordingParamsLayersOutputsStorageConfigTypeDigitalocean RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType = "digitalocean" RecordingStartTrackRecordingParamsLayersOutputsStorageConfigTypeGcs RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType = "gcs" RecordingStartTrackRecordingParamsLayersOutputsStorageConfigTypeSftp RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType = "sftp" )
func (RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType) IsKnown ¶
func (r RecordingStartTrackRecordingParamsLayersOutputsStorageConfigType) IsKnown() bool
type RecordingStartTrackRecordingParamsLayersOutputsType ¶
type RecordingStartTrackRecordingParamsLayersOutputsType string
The type of output destination this layer is being exported to.
const ( RecordingStartTrackRecordingParamsLayersOutputsTypeRealtimekitBucket RecordingStartTrackRecordingParamsLayersOutputsType = "REALTIMEKIT_BUCKET" RecordingStartTrackRecordingParamsLayersOutputsTypeStorageConfig RecordingStartTrackRecordingParamsLayersOutputsType = "STORAGE_CONFIG" )
func (RecordingStartTrackRecordingParamsLayersOutputsType) IsKnown ¶
func (r RecordingStartTrackRecordingParamsLayersOutputsType) IsKnown() bool
type ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type RolePermissions ¶
type RolePermissions = shared.RolePermissions
This is an alias to an internal type.
type RolePermissionsParam ¶
type RolePermissionsParam = shared.RolePermissionsParam
This is an alias to an internal type.
type SessionGetParticipantDataFromPeerIDParams ¶
type SessionGetParticipantDataFromPeerIDParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Comma separated list of filters to apply. Note that there must be no spaces
// between the filters.
Filters param.Field[SessionGetParticipantDataFromPeerIDParamsFilters] `query:"filters"`
}
func (SessionGetParticipantDataFromPeerIDParams) URLQuery ¶
func (r SessionGetParticipantDataFromPeerIDParams) URLQuery() (v url.Values)
URLQuery serializes SessionGetParticipantDataFromPeerIDParams's query parameters as `url.Values`.
type SessionGetParticipantDataFromPeerIDParamsFilters ¶
type SessionGetParticipantDataFromPeerIDParamsFilters string
Comma separated list of filters to apply. Note that there must be no spaces between the filters.
const ( SessionGetParticipantDataFromPeerIDParamsFiltersDeviceInfo SessionGetParticipantDataFromPeerIDParamsFilters = "device_info" SessionGetParticipantDataFromPeerIDParamsFiltersIPInformation SessionGetParticipantDataFromPeerIDParamsFilters = "ip_information" SessionGetParticipantDataFromPeerIDParamsFiltersPrecallNetworkInformation SessionGetParticipantDataFromPeerIDParamsFilters = "precall_network_information" SessionGetParticipantDataFromPeerIDParamsFiltersEvents SessionGetParticipantDataFromPeerIDParamsFilters = "events" SessionGetParticipantDataFromPeerIDParamsFiltersQualityStats SessionGetParticipantDataFromPeerIDParamsFilters = "quality_stats" )
func (SessionGetParticipantDataFromPeerIDParamsFilters) IsKnown ¶
func (r SessionGetParticipantDataFromPeerIDParamsFilters) IsKnown() bool
type SessionGetParticipantDataFromPeerIDResponse ¶
type SessionGetParticipantDataFromPeerIDResponse struct {
Data SessionGetParticipantDataFromPeerIDResponseData `json:"data"`
Success bool `json:"success"`
JSON sessionGetParticipantDataFromPeerIDResponseJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponse) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponse) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseData ¶
type SessionGetParticipantDataFromPeerIDResponseData struct {
Participant SessionGetParticipantDataFromPeerIDResponseDataParticipant `json:"participant"`
JSON sessionGetParticipantDataFromPeerIDResponseDataJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseData) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseData) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipant ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipant struct {
ID string `json:"id"`
CreatedAt string `json:"created_at"`
CustomParticipantID string `json:"custom_participant_id"`
DisplayName string `json:"display_name"`
Duration float64 `json:"duration"`
JoinedAt string `json:"joined_at"`
LeftAt string `json:"left_at"`
PeerReport SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReport `json:"peer_report"`
PeerStats SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStats `json:"peer_stats"`
QualityStats SessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStats `json:"quality_stats"`
Role string `json:"role"`
UpdatedAt string `json:"updated_at"`
UserID string `json:"user_id"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipant) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipant) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReport ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReport struct {
Metadata SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadata `json:"metadata"`
Quality SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQuality `json:"quality"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReport) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReport) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadata ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadata struct {
AudioDevicesUpdates []interface{} `json:"audio_devices_updates"`
BrowserMetadata SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadata `json:"browser_metadata"`
CandidatePairs SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairs `json:"candidate_pairs"`
DeviceInfo SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfo `json:"device_info"`
Events []SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEvent `json:"events"`
IPInformation SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformation `json:"ip_information"`
PcMetadata []SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadata `json:"pc_metadata"`
RoomViewType string `json:"room_view_type"`
SDKName string `json:"sdk_name"`
SDKVersion string `json:"sdk_version"`
SelectedDeviceUpdates []interface{} `json:"selected_device_updates"`
SpeakerDevicesUpdates []interface{} `json:"speaker_devices_updates"`
VideoDevicesUpdates []interface{} `json:"video_devices_updates"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadata) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadata) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadata ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadata struct {
Browser string `json:"browser"`
BrowserVersion string `json:"browser_version"`
Engine string `json:"engine"`
UserAgent string `json:"user_agent"`
WebglSupport string `json:"webgl_support"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadataJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadata) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataBrowserMetadata) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairs ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairs struct {
ConsumingTransport []interface{} `json:"consuming_transport"`
ProducingTransport []SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransport `json:"producing_transport"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairs) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairs) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransport ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransport struct {
AvailableOutgoingBitrate int64 `json:"available_outgoing_bitrate"`
BytesDiscardedOnSend int64 `json:"bytes_discarded_on_send"`
BytesReceived int64 `json:"bytes_received"`
BytesSent int64 `json:"bytes_sent"`
CurrentRoundTripTime float64 `json:"current_round_trip_time"`
LastPacketReceivedTimestamp int64 `json:"last_packet_received_timestamp"`
LastPacketSentTimestamp int64 `json:"last_packet_sent_timestamp"`
LocalCandidateAddress string `json:"local_candidate_address"`
LocalCandidateID string `json:"local_candidate_id"`
LocalCandidateNetworkType string `json:"local_candidate_network_type"`
LocalCandidatePort int64 `json:"local_candidate_port"`
LocalCandidateProtocol string `json:"local_candidate_protocol"`
LocalCandidateRelatedAddress string `json:"local_candidate_related_address"`
LocalCandidateRelatedPort int64 `json:"local_candidate_related_port"`
LocalCandidateType string `json:"local_candidate_type"`
Nominated bool `json:"nominated"`
PacketsDiscardedOnSend int64 `json:"packets_discarded_on_send"`
PacketsReceived int64 `json:"packets_received"`
PacketsSent int64 `json:"packets_sent"`
RemoteCandidateAddress string `json:"remote_candidate_address"`
RemoteCandidateID string `json:"remote_candidate_id"`
RemoteCandidatePort int64 `json:"remote_candidate_port"`
RemoteCandidateProtocol string `json:"remote_candidate_protocol"`
RemoteCandidateType string `json:"remote_candidate_type"`
TotalRoundTripTime float64 `json:"total_round_trip_time"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransportJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransport) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataCandidatePairsProducingTransport) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfo ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfo struct {
CPUs int64 `json:"cpus"`
IsMobile bool `json:"is_mobile"`
OS string `json:"os"`
OSVersion string `json:"os_version"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfoJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfo) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataDeviceInfo) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEvent ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEvent struct {
Name string `json:"name"`
Timestamp string `json:"timestamp"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEventJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEvent) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataEvent) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformation ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformation struct {
ASN SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASN `json:"asn"`
City string `json:"city"`
Country string `json:"country"`
IPV4 string `json:"ipv4"`
Region string `json:"region"`
Timezone string `json:"timezone"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformation) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformation) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASN ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASN struct {
ASN string `json:"asn"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASNJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASN) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataIPInformationASN) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadata ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadata struct {
EffectiveNetworkType string `json:"effective_network_type"`
ReflexiveConnectivity bool `json:"reflexive_connectivity"`
RelayConnectivity bool `json:"relay_connectivity"`
Timestamp string `json:"timestamp"`
TURNConnectivity bool `json:"turn_connectivity"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadataJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadata) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportMetadataPcMetadata) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQuality ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQuality struct {
AudioConsumer []interface{} `json:"audio_consumer"`
AudioConsumerCumulative interface{} `json:"audio_consumer_cumulative"`
AudioProducer []SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducer `json:"audio_producer"`
AudioProducerCumulative SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulative `json:"audio_producer_cumulative"`
VideoConsumer []interface{} `json:"video_consumer"`
VideoConsumerCumulative interface{} `json:"video_consumer_cumulative"`
VideoProducer []interface{} `json:"video_producer"`
VideoProducerCumulative interface{} `json:"video_producer_cumulative"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQuality) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQuality) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducer ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducer struct {
BytesSent int64 `json:"bytes_sent"`
Jitter int64 `json:"jitter"`
Mid string `json:"mid"`
MosQuality int64 `json:"mos_quality"`
PacketsLost int64 `json:"packets_lost"`
PacketsSent int64 `json:"packets_sent"`
ProducerID string `json:"producer_id"`
RTT float64 `json:"rtt"`
Ssrc int64 `json:"ssrc"`
Timestamp string `json:"timestamp"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducer) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducer) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulative ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulative struct {
PacketLoss SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLoss `json:"packet_loss"`
QualityMos SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMos `json:"quality_mos"`
RTT SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTT `json:"rtt"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulative) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulative) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLoss ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLoss struct {
Number10OrGreaterEventFraction int64 `json:"10_or_greater_event_fraction"`
Number25OrGreaterEventFraction int64 `json:"25_or_greater_event_fraction"`
Number5OrGreaterEventFraction int64 `json:"5_or_greater_event_fraction"`
Number50OrGreaterEventFraction int64 `json:"50_or_greater_event_fraction"`
Avg int64 `json:"avg"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLossJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLoss) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativePacketLoss) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMos ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMos struct {
Avg int64 `json:"avg"`
P50 int64 `json:"p50"`
P75 int64 `json:"p75"`
P90 int64 `json:"p90"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMosJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMos) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeQualityMos) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTT ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTT struct {
Number100msOrGreaterEventFraction float64 `json:"100ms_or_greater_event_fraction"`
Number250msOrGreaterEventFraction float64 `json:"250ms_or_greater_event_fraction"`
Number500msOrGreaterEventFraction float64 `json:"500ms_or_greater_event_fraction"`
Avg float64 `json:"avg"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTTJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTT) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerReportQualityAudioProducerCumulativeRTT) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStats ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStats struct {
DeviceInfo SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfo `json:"device_info"`
Events []SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEvent `json:"events"`
IPInformation SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformation `json:"ip_information"`
PrecallNetworkInformation SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformation `json:"precall_network_information"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStats) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStats) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfo ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfo struct {
Browser string `json:"browser"`
BrowserVersion string `json:"browser_version"`
CPUs int64 `json:"cpus"`
Engine string `json:"engine"`
IsMobile bool `json:"is_mobile"`
OS string `json:"os"`
OSVersion string `json:"os_version"`
SDKName string `json:"sdk_name"`
SDKVersion string `json:"sdk_version"`
UserAgent string `json:"user_agent"`
WebglSupport string `json:"webgl_support"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfoJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfo) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsDeviceInfo) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEvent ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEvent struct {
Metadata SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadata `json:"metadata"`
Timestamp string `json:"timestamp"`
Type string `json:"type"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEvent) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEvent) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadata ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadata struct {
ConnectionInfo SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfo `json:"connection_info"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadata) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadata) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfo ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfo struct {
BackendRTT float64 `json:"backend_r_t_t"`
Connectivity SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivity `json:"connectivity"`
EffectiveNetworkType string `json:"effective_network_type"`
FractionalLoss int64 `json:"fractional_loss"`
IPDetails SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetails `json:"ip_details"`
Jitter int64 `json:"jitter"`
Location SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocation `json:"location"`
RTT float64 `json:"r_t_t"`
Throughput int64 `json:"throughput"`
TURNConnectivity bool `json:"turn_connectivity"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfo) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfo) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivity ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivity struct {
Host bool `json:"host"`
Reflexive bool `json:"reflexive"`
Relay bool `json:"relay"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivityJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivity) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoConnectivity) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetails ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetails struct {
ASN SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASN `json:"asn"`
City string `json:"city"`
Country string `json:"country"`
IP string `json:"ip"`
LOC string `json:"loc"`
Postal string `json:"postal"`
Region string `json:"region"`
Timezone string `json:"timezone"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetails) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetails) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASN ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASN struct {
ASN string `json:"asn"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASNJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASN) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoIPDetailsASN) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocation ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocation struct {
Coords SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoords `json:"coords"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocation) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocation) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoords ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoords struct {
Latitude float64 `json:"latitude"`
Longitude float64 `json:"longitude"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoordsJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoords) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsEventsMetadataConnectionInfoLocationCoords) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformation ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformation struct {
ASN SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASN `json:"asn"`
City string `json:"city"`
Country string `json:"country"`
IPLocation string `json:"ip_location"`
IPV4 string `json:"ipv4"`
Org string `json:"org"`
Region string `json:"region"`
Timezone string `json:"timezone"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformation) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformation) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASN ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASN struct {
ASN string `json:"asn"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASNJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASN) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsIPInformationASN) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformation ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformation struct {
BackendRTT float64 `json:"backend_rtt"`
EffectiveNetworktype string `json:"effective_networktype"`
FractionalLoss int64 `json:"fractional_loss"`
Jitter int64 `json:"jitter"`
ReflexiveConnectivity bool `json:"reflexive_connectivity"`
RelayConnectivity bool `json:"relay_connectivity"`
RTT float64 `json:"rtt"`
Throughput int64 `json:"throughput"`
TURNConnectivity bool `json:"turn_connectivity"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformationJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformation) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantPeerStatsPrecallNetworkInformation) UnmarshalJSON(data []byte) (err error)
type SessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStats ¶
type SessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStats struct {
AudioBandwidth int64 `json:"audio_bandwidth"`
AudioStats []interface{} `json:"audio_stats"`
AverageQuality int64 `json:"average_quality"`
End string `json:"end" api:"nullable"`
FirstAudioPacketReceived string `json:"first_audio_packet_received"`
FirstVideoPacketReceived string `json:"first_video_packet_received"`
LastAudioPacketReceived string `json:"last_audio_packet_received"`
LastVideoPacketReceived string `json:"last_video_packet_received"`
PeerIDs []string `json:"peer_ids"`
Start string `json:"start" api:"nullable"`
TotalAudioPackets int64 `json:"total_audio_packets"`
TotalAudioPacketsLost int64 `json:"total_audio_packets_lost"`
TotalVideoPackets int64 `json:"total_video_packets"`
TotalVideoPacketsLost int64 `json:"total_video_packets_lost"`
VideoBandwidth int64 `json:"video_bandwidth"`
VideoStats []interface{} `json:"video_stats"`
JSON sessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStatsJSON `json:"-"`
}
func (*SessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStats) UnmarshalJSON ¶
func (r *SessionGetParticipantDataFromPeerIDResponseDataParticipantQualityStats) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionChatResponse ¶
type SessionGetSessionChatResponse struct {
Data SessionGetSessionChatResponseData `json:"data"`
Success bool `json:"success"`
JSON sessionGetSessionChatResponseJSON `json:"-"`
}
func (*SessionGetSessionChatResponse) UnmarshalJSON ¶
func (r *SessionGetSessionChatResponse) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionChatResponseData ¶
type SessionGetSessionChatResponseData struct {
// URL where the chat logs can be downloaded
ChatDownloadURL string `json:"chat_download_url" api:"required"`
// Time when the download URL will expire
ChatDownloadURLExpiry string `json:"chat_download_url_expiry" api:"required"`
JSON sessionGetSessionChatResponseDataJSON `json:"-"`
}
func (*SessionGetSessionChatResponseData) UnmarshalJSON ¶
func (r *SessionGetSessionChatResponseData) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionDetailsParams ¶
type SessionGetSessionDetailsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// List all breakout rooms
IncludeBreakoutRooms param.Field[bool] `query:"include_breakout_rooms"`
}
func (SessionGetSessionDetailsParams) URLQuery ¶
func (r SessionGetSessionDetailsParams) URLQuery() (v url.Values)
URLQuery serializes SessionGetSessionDetailsParams's query parameters as `url.Values`.
type SessionGetSessionDetailsResponse ¶
type SessionGetSessionDetailsResponse struct {
Data SessionGetSessionDetailsResponseData `json:"data"`
Success bool `json:"success"`
JSON sessionGetSessionDetailsResponseJSON `json:"-"`
}
func (*SessionGetSessionDetailsResponse) UnmarshalJSON ¶
func (r *SessionGetSessionDetailsResponse) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionDetailsResponseData ¶
type SessionGetSessionDetailsResponseData struct {
Session SessionGetSessionDetailsResponseDataSession `json:"session"`
JSON sessionGetSessionDetailsResponseDataJSON `json:"-"`
}
func (*SessionGetSessionDetailsResponseData) UnmarshalJSON ¶
func (r *SessionGetSessionDetailsResponseData) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionDetailsResponseDataSession ¶
type SessionGetSessionDetailsResponseDataSession struct {
// ID of the session
ID string `json:"id" api:"required"`
// ID of the meeting this session is associated with. In the case of V2 meetings,
// it is always a UUID. In V1 meetings, it is a room name of the form
// `abcdef-ghijkl`
AssociatedID string `json:"associated_id" api:"required"`
// timestamp when session created
CreatedAt string `json:"created_at" api:"required"`
// number of participants currently in the session
LiveParticipants float64 `json:"live_participants" api:"required"`
// number of maximum participants that were in the session
MaxConcurrentParticipants float64 `json:"max_concurrent_participants" api:"required"`
// Title of the meeting this session belongs to
MeetingDisplayName string `json:"meeting_display_name" api:"required"`
// number of minutes consumed since the session started
MinutesConsumed float64 `json:"minutes_consumed" api:"required"`
// App id that hosted this session
OrganizationID string `json:"organization_id" api:"required"`
// timestamp when session started
StartedAt string `json:"started_at" api:"required"`
// current status of session
Status SessionGetSessionDetailsResponseDataSessionStatus `json:"status" api:"required"`
// type of session
Type SessionGetSessionDetailsResponseDataSessionType `json:"type" api:"required"`
// timestamp when session was last updated
UpdatedAt string `json:"updated_at" api:"required"`
BreakoutRooms []interface{} `json:"breakout_rooms"`
// timestamp when session ended
EndedAt string `json:"ended_at"`
// Any meta data about session.
Meta interface{} `json:"meta"`
JSON sessionGetSessionDetailsResponseDataSessionJSON `json:"-"`
}
func (*SessionGetSessionDetailsResponseDataSession) UnmarshalJSON ¶
func (r *SessionGetSessionDetailsResponseDataSession) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionDetailsResponseDataSessionStatus ¶
type SessionGetSessionDetailsResponseDataSessionStatus string
current status of session
const ( SessionGetSessionDetailsResponseDataSessionStatusLive SessionGetSessionDetailsResponseDataSessionStatus = "LIVE" SessionGetSessionDetailsResponseDataSessionStatusEnded SessionGetSessionDetailsResponseDataSessionStatus = "ENDED" )
func (SessionGetSessionDetailsResponseDataSessionStatus) IsKnown ¶
func (r SessionGetSessionDetailsResponseDataSessionStatus) IsKnown() bool
type SessionGetSessionDetailsResponseDataSessionType ¶
type SessionGetSessionDetailsResponseDataSessionType string
type of session
const ( SessionGetSessionDetailsResponseDataSessionTypeMeeting SessionGetSessionDetailsResponseDataSessionType = "meeting" SessionGetSessionDetailsResponseDataSessionTypeLivestream SessionGetSessionDetailsResponseDataSessionType = "livestream" SessionGetSessionDetailsResponseDataSessionTypeParticipant SessionGetSessionDetailsResponseDataSessionType = "participant" )
func (SessionGetSessionDetailsResponseDataSessionType) IsKnown ¶
func (r SessionGetSessionDetailsResponseDataSessionType) IsKnown() bool
type SessionGetSessionParticipantDetailsParams ¶
type SessionGetSessionParticipantDetailsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Comma separated list of filters to apply. Note that there must be no spaces
// between the filters.
Filters param.Field[SessionGetSessionParticipantDetailsParamsFilters] `query:"filters"`
// if true, response includes all the peer events of participant.
IncludePeerEvents param.Field[bool] `query:"include_peer_events"`
}
func (SessionGetSessionParticipantDetailsParams) URLQuery ¶
func (r SessionGetSessionParticipantDetailsParams) URLQuery() (v url.Values)
URLQuery serializes SessionGetSessionParticipantDetailsParams's query parameters as `url.Values`.
type SessionGetSessionParticipantDetailsParamsFilters ¶
type SessionGetSessionParticipantDetailsParamsFilters string
Comma separated list of filters to apply. Note that there must be no spaces between the filters.
const ( SessionGetSessionParticipantDetailsParamsFiltersDeviceInfo SessionGetSessionParticipantDetailsParamsFilters = "device_info" SessionGetSessionParticipantDetailsParamsFiltersIPInformation SessionGetSessionParticipantDetailsParamsFilters = "ip_information" SessionGetSessionParticipantDetailsParamsFiltersPrecallNetworkInformation SessionGetSessionParticipantDetailsParamsFilters = "precall_network_information" SessionGetSessionParticipantDetailsParamsFiltersEvents SessionGetSessionParticipantDetailsParamsFilters = "events" SessionGetSessionParticipantDetailsParamsFiltersQualityStats SessionGetSessionParticipantDetailsParamsFilters = "quality_stats" )
func (SessionGetSessionParticipantDetailsParamsFilters) IsKnown ¶
func (r SessionGetSessionParticipantDetailsParamsFilters) IsKnown() bool
type SessionGetSessionParticipantDetailsResponse ¶
type SessionGetSessionParticipantDetailsResponse struct {
Data SessionGetSessionParticipantDetailsResponseData `json:"data"`
Success bool `json:"success"`
JSON sessionGetSessionParticipantDetailsResponseJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponse) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponse) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantDetailsResponseData ¶
type SessionGetSessionParticipantDetailsResponseData struct {
Participant SessionGetSessionParticipantDetailsResponseDataParticipant `json:"participant"`
JSON sessionGetSessionParticipantDetailsResponseDataJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponseData) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponseData) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantDetailsResponseDataParticipant ¶
type SessionGetSessionParticipantDetailsResponseDataParticipant struct {
// Participant ID. This maps to the corresponding peerId.
ID string `json:"id"`
// timestamp when this participant was created.
CreatedAt string `json:"created_at"`
// ID passed by client to create this participant.
CustomParticipantID string `json:"custom_participant_id"`
// Display name of participant when joining the session.
DisplayName string `json:"display_name"`
// number of minutes for which the participant was in the session.
Duration float64 `json:"duration"`
// timestamp at which participant joined the session.
JoinedAt string `json:"joined_at"`
// timestamp at which participant left the session.
LeftAt string `json:"left_at"`
PeerStats SessionGetSessionParticipantDetailsResponseDataParticipantPeerStats `json:"peer_stats"`
// Name of the preset associated with the participant.
PresetName string `json:"preset_name"`
QualityStats []SessionGetSessionParticipantDetailsResponseDataParticipantQualityStat `json:"quality_stats"`
// timestamp when this participant's data was last updated.
UpdatedAt string `json:"updated_at"`
// User id for this participant.
UserID string `json:"user_id"`
JSON sessionGetSessionParticipantDetailsResponseDataParticipantJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponseDataParticipant) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponseDataParticipant) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStats ¶
type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStats struct {
Config string `json:"config"`
DeviceInfo SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfo `json:"device_info"`
Events []SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEvent `json:"events"`
IPInformation SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformation `json:"ip_information"`
PrecallNetworkInformation SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformation `json:"precall_network_information"`
Status string `json:"status"`
JSON sessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponseDataParticipantPeerStats) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponseDataParticipantPeerStats) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfo ¶
type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfo struct {
Browser string `json:"browser"`
BrowserVersion string `json:"browser_version"`
CPUs float64 `json:"cpus"`
Engine string `json:"engine"`
IsMobile bool `json:"is_mobile"`
Memory float64 `json:"memory"`
OS string `json:"os"`
OSVersion string `json:"os_version"`
SDKName string `json:"sdk_name"`
SDKVersion string `json:"sdk_version"`
UserAgent string `json:"user_agent"`
WebglSupport string `json:"webgl_support"`
JSON sessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfoJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfo) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsDeviceInfo) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEvent ¶
type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEvent struct {
Timestamp string `json:"timestamp"`
Type string `json:"type"`
JSON sessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEventJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEvent) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsEvent) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformation ¶
type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformation struct {
City string `json:"city"`
Country string `json:"country"`
IPLocation string `json:"ip_location"`
IPV4 string `json:"ipv4"`
Org string `json:"org"`
Portal string `json:"portal"`
Region string `json:"region"`
Timezone string `json:"timezone"`
JSON sessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformationJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformation) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsIPInformation) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformation ¶
type SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformation struct {
BackendRTT float64 `json:"backend_rtt"`
EffectiveNetworktype string `json:"effective_networktype"`
FractionalLoss float64 `json:"fractional_loss"`
Jitter float64 `json:"jitter"`
ReflexiveConnectivity bool `json:"reflexive_connectivity"`
RelayConnectivity bool `json:"relay_connectivity"`
RTT float64 `json:"rtt"`
Throughtput float64 `json:"throughtput"`
TURNConnectivity bool `json:"turn_connectivity"`
JSON sessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformationJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformation) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponseDataParticipantPeerStatsPrecallNetworkInformation) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStat ¶
type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStat struct {
AudioBandwidth float64 `json:"audio_bandwidth"`
AudioPacketLoss float64 `json:"audio_packet_loss"`
AudioStats []SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStat `json:"audio_stats"`
AverageQuality float64 `json:"average_quality"`
End string `json:"end"`
PeerID string `json:"peer_id"`
Start string `json:"start"`
VideoBandwidth float64 `json:"video_bandwidth"`
VideoPacketLoss float64 `json:"video_packet_loss"`
VideoStats []SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStat `json:"video_stats"`
JSON sessionGetSessionParticipantDetailsResponseDataParticipantQualityStatJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponseDataParticipantQualityStat) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponseDataParticipantQualityStat) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStat ¶
type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStat struct {
ConcealmentEvents float64 `json:"concealment_events"`
Jitter float64 `json:"jitter"`
PacketsLost float64 `json:"packets_lost"`
Quality float64 `json:"quality"`
Timestamp string `json:"timestamp"`
JSON sessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStatJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStat) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsAudioStat) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStat ¶
type SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStat struct {
FrameHeight float64 `json:"frame_height"`
FrameWidth float64 `json:"frame_width"`
FramesDropped float64 `json:"frames_dropped"`
FramesPerSecond float64 `json:"frames_per_second"`
Jitter float64 `json:"jitter"`
PacketsLost float64 `json:"packets_lost"`
Quality float64 `json:"quality"`
Timestamp string `json:"timestamp"`
JSON sessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStatJSON `json:"-"`
}
func (*SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStat) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantDetailsResponseDataParticipantQualityStatsVideoStat) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantsParams ¶
type SessionGetSessionParticipantsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// if true, response includes all the peer events of participants.
IncludePeerEvents param.Field[bool] `query:"include_peer_events"`
// The page number from which you want your page search results to be displayed.
PageNo param.Field[float64] `query:"page_no"`
// Number of results per page
PerPage param.Field[float64] `query:"per_page"`
// The search query string. You can search using the meeting ID or title.
Search param.Field[string] `query:"search"`
SortBy param.Field[SessionGetSessionParticipantsParamsSortBy] `query:"sort_by"`
SortOrder param.Field[SessionGetSessionParticipantsParamsSortOrder] `query:"sort_order"`
// In breakout room sessions, the view parameter can be set to `raw` for session
// specific duration for participants or `consolidated` to accumulate breakout room
// durations.
View param.Field[SessionGetSessionParticipantsParamsView] `query:"view"`
}
func (SessionGetSessionParticipantsParams) URLQuery ¶
func (r SessionGetSessionParticipantsParams) URLQuery() (v url.Values)
URLQuery serializes SessionGetSessionParticipantsParams's query parameters as `url.Values`.
type SessionGetSessionParticipantsParamsSortBy ¶
type SessionGetSessionParticipantsParamsSortBy string
const ( SessionGetSessionParticipantsParamsSortByJoinedAt SessionGetSessionParticipantsParamsSortBy = "joinedAt" SessionGetSessionParticipantsParamsSortByDuration SessionGetSessionParticipantsParamsSortBy = "duration" )
func (SessionGetSessionParticipantsParamsSortBy) IsKnown ¶
func (r SessionGetSessionParticipantsParamsSortBy) IsKnown() bool
type SessionGetSessionParticipantsParamsSortOrder ¶
type SessionGetSessionParticipantsParamsSortOrder string
const ( SessionGetSessionParticipantsParamsSortOrderAsc SessionGetSessionParticipantsParamsSortOrder = "ASC" SessionGetSessionParticipantsParamsSortOrderDesc SessionGetSessionParticipantsParamsSortOrder = "DESC" )
func (SessionGetSessionParticipantsParamsSortOrder) IsKnown ¶
func (r SessionGetSessionParticipantsParamsSortOrder) IsKnown() bool
type SessionGetSessionParticipantsParamsView ¶
type SessionGetSessionParticipantsParamsView string
In breakout room sessions, the view parameter can be set to `raw` for session specific duration for participants or `consolidated` to accumulate breakout room durations.
const ( SessionGetSessionParticipantsParamsViewRaw SessionGetSessionParticipantsParamsView = "raw" SessionGetSessionParticipantsParamsViewConsolidated SessionGetSessionParticipantsParamsView = "consolidated" )
func (SessionGetSessionParticipantsParamsView) IsKnown ¶
func (r SessionGetSessionParticipantsParamsView) IsKnown() bool
type SessionGetSessionParticipantsResponse ¶
type SessionGetSessionParticipantsResponse struct {
Data SessionGetSessionParticipantsResponseData `json:"data"`
Success bool `json:"success"`
JSON sessionGetSessionParticipantsResponseJSON `json:"-"`
}
func (*SessionGetSessionParticipantsResponse) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantsResponse) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantsResponseData ¶
type SessionGetSessionParticipantsResponseData struct {
Participants []SessionGetSessionParticipantsResponseDataParticipant `json:"participants"`
JSON sessionGetSessionParticipantsResponseDataJSON `json:"-"`
}
func (*SessionGetSessionParticipantsResponseData) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantsResponseData) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionParticipantsResponseDataParticipant ¶
type SessionGetSessionParticipantsResponseDataParticipant struct {
// Participant ID. This maps to the corresponding peerId.
ID string `json:"id"`
// timestamp when this participant was created.
CreatedAt string `json:"created_at"`
// ID passed by client to create this participant.
CustomParticipantID string `json:"custom_participant_id"`
// Display name of participant when joining the session.
DisplayName string `json:"display_name"`
// number of minutes for which the participant was in the session.
Duration float64 `json:"duration"`
// timestamp at which participant joined the session.
JoinedAt string `json:"joined_at"`
// timestamp at which participant left the session.
LeftAt string `json:"left_at"`
// Name of the preset associated with the participant.
PresetName string `json:"preset_name"`
// timestamp when this participant's data was last updated.
UpdatedAt string `json:"updated_at"`
// User id for this participant.
UserID string `json:"user_id"`
JSON sessionGetSessionParticipantsResponseDataParticipantJSON `json:"-"`
}
func (*SessionGetSessionParticipantsResponseDataParticipant) UnmarshalJSON ¶
func (r *SessionGetSessionParticipantsResponseDataParticipant) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionSummaryResponse ¶
type SessionGetSessionSummaryResponse struct {
Data SessionGetSessionSummaryResponseData `json:"data"`
Success bool `json:"success"`
JSON sessionGetSessionSummaryResponseJSON `json:"-"`
}
func (*SessionGetSessionSummaryResponse) UnmarshalJSON ¶
func (r *SessionGetSessionSummaryResponse) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionSummaryResponseData ¶
type SessionGetSessionSummaryResponseData struct {
SessionID string `json:"sessionId" api:"required"`
// URL where the summary of transcripts can be downloaded
SummaryDownloadURL string `json:"summaryDownloadUrl" api:"required"`
// Time of Expiry before when you need to download the csv file.
SummaryDownloadURLExpiry string `json:"summaryDownloadUrlExpiry" api:"required"`
JSON sessionGetSessionSummaryResponseDataJSON `json:"-"`
}
func (*SessionGetSessionSummaryResponseData) UnmarshalJSON ¶
func (r *SessionGetSessionSummaryResponseData) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionTranscriptsResponse ¶
type SessionGetSessionTranscriptsResponse struct {
Data SessionGetSessionTranscriptsResponseData `json:"data"`
Success bool `json:"success"`
JSON sessionGetSessionTranscriptsResponseJSON `json:"-"`
}
func (*SessionGetSessionTranscriptsResponse) UnmarshalJSON ¶
func (r *SessionGetSessionTranscriptsResponse) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionTranscriptsResponseData ¶
type SessionGetSessionTranscriptsResponseData struct {
SessionID string `json:"sessionId" api:"required"`
// URL where the transcript can be downloaded
TranscriptDownloadURL string `json:"transcript_download_url" api:"required"`
// Time when the download URL will expire
TranscriptDownloadURLExpiry string `json:"transcript_download_url_expiry" api:"required"`
JSON sessionGetSessionTranscriptsResponseDataJSON `json:"-"`
}
func (*SessionGetSessionTranscriptsResponseData) UnmarshalJSON ¶
func (r *SessionGetSessionTranscriptsResponseData) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionsParams ¶
type SessionGetSessionsParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// ID of the meeting that sessions should be associated with
AssociatedID param.Field[string] `query:"associated_id"`
// The end time range for which you want to retrieve the meetings. The time must be
// specified in ISO format.
EndTime param.Field[time.Time] `query:"end_time" format:"date-time"`
// The page number from which you want your page search results to be displayed.
PageNo param.Field[float64] `query:"page_no"`
Participants param.Field[string] `query:"participants"`
// Number of results per page
PerPage param.Field[float64] `query:"per_page"`
// Search string that matches sessions based on meeting title, meeting ID, and
// session ID
Search param.Field[string] `query:"search"`
SortBy param.Field[SessionGetSessionsParamsSortBy] `query:"sort_by"`
SortOrder param.Field[SessionGetSessionsParamsSortOrder] `query:"sort_order"`
// The start time range for which you want to retrieve the meetings. The time must
// be specified in ISO format.
StartTime param.Field[time.Time] `query:"start_time" format:"date-time"`
Status param.Field[SessionGetSessionsParamsStatus] `query:"status"`
}
func (SessionGetSessionsParams) URLQuery ¶
func (r SessionGetSessionsParams) URLQuery() (v url.Values)
URLQuery serializes SessionGetSessionsParams's query parameters as `url.Values`.
type SessionGetSessionsParamsSortBy ¶
type SessionGetSessionsParamsSortBy string
const ( SessionGetSessionsParamsSortByMinutesConsumed SessionGetSessionsParamsSortBy = "minutesConsumed" SessionGetSessionsParamsSortByCreatedAt SessionGetSessionsParamsSortBy = "createdAt" )
func (SessionGetSessionsParamsSortBy) IsKnown ¶
func (r SessionGetSessionsParamsSortBy) IsKnown() bool
type SessionGetSessionsParamsSortOrder ¶
type SessionGetSessionsParamsSortOrder string
const ( SessionGetSessionsParamsSortOrderAsc SessionGetSessionsParamsSortOrder = "ASC" SessionGetSessionsParamsSortOrderDesc SessionGetSessionsParamsSortOrder = "DESC" )
func (SessionGetSessionsParamsSortOrder) IsKnown ¶
func (r SessionGetSessionsParamsSortOrder) IsKnown() bool
type SessionGetSessionsParamsStatus ¶
type SessionGetSessionsParamsStatus string
const ( SessionGetSessionsParamsStatusLive SessionGetSessionsParamsStatus = "LIVE" SessionGetSessionsParamsStatusEnded SessionGetSessionsParamsStatus = "ENDED" )
func (SessionGetSessionsParamsStatus) IsKnown ¶
func (r SessionGetSessionsParamsStatus) IsKnown() bool
type SessionGetSessionsResponse ¶
type SessionGetSessionsResponse struct {
Data SessionGetSessionsResponseData `json:"data"`
Success bool `json:"success"`
JSON sessionGetSessionsResponseJSON `json:"-"`
}
func (*SessionGetSessionsResponse) UnmarshalJSON ¶
func (r *SessionGetSessionsResponse) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionsResponseData ¶
type SessionGetSessionsResponseData struct {
Sessions []SessionGetSessionsResponseDataSession `json:"sessions"`
JSON sessionGetSessionsResponseDataJSON `json:"-"`
}
func (*SessionGetSessionsResponseData) UnmarshalJSON ¶
func (r *SessionGetSessionsResponseData) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionsResponseDataSession ¶
type SessionGetSessionsResponseDataSession struct {
// ID of the session
ID string `json:"id" api:"required"`
// ID of the meeting this session is associated with. In the case of V2 meetings,
// it is always a UUID. In V1 meetings, it is a room name of the form
// `abcdef-ghijkl`
AssociatedID string `json:"associated_id" api:"required"`
// timestamp when session created
CreatedAt string `json:"created_at" api:"required"`
// number of participants currently in the session
LiveParticipants float64 `json:"live_participants" api:"required"`
// number of maximum participants that were in the session
MaxConcurrentParticipants float64 `json:"max_concurrent_participants" api:"required"`
// Title of the meeting this session belongs to
MeetingDisplayName string `json:"meeting_display_name" api:"required"`
// number of minutes consumed since the session started
MinutesConsumed float64 `json:"minutes_consumed" api:"required"`
// App id that hosted this session
OrganizationID string `json:"organization_id" api:"required"`
// timestamp when session started
StartedAt string `json:"started_at" api:"required"`
// current status of session
Status SessionGetSessionsResponseDataSessionsStatus `json:"status" api:"required"`
// type of session
Type SessionGetSessionsResponseDataSessionsType `json:"type" api:"required"`
// timestamp when session was last updated
UpdatedAt string `json:"updated_at" api:"required"`
BreakoutRooms []interface{} `json:"breakout_rooms"`
// timestamp when session ended
EndedAt string `json:"ended_at"`
// Any meta data about session.
Meta interface{} `json:"meta"`
JSON sessionGetSessionsResponseDataSessionJSON `json:"-"`
}
func (*SessionGetSessionsResponseDataSession) UnmarshalJSON ¶
func (r *SessionGetSessionsResponseDataSession) UnmarshalJSON(data []byte) (err error)
type SessionGetSessionsResponseDataSessionsStatus ¶
type SessionGetSessionsResponseDataSessionsStatus string
current status of session
const ( SessionGetSessionsResponseDataSessionsStatusLive SessionGetSessionsResponseDataSessionsStatus = "LIVE" SessionGetSessionsResponseDataSessionsStatusEnded SessionGetSessionsResponseDataSessionsStatus = "ENDED" )
func (SessionGetSessionsResponseDataSessionsStatus) IsKnown ¶
func (r SessionGetSessionsResponseDataSessionsStatus) IsKnown() bool
type SessionGetSessionsResponseDataSessionsType ¶
type SessionGetSessionsResponseDataSessionsType string
type of session
const ( SessionGetSessionsResponseDataSessionsTypeMeeting SessionGetSessionsResponseDataSessionsType = "meeting" SessionGetSessionsResponseDataSessionsTypeLivestream SessionGetSessionsResponseDataSessionsType = "livestream" SessionGetSessionsResponseDataSessionsTypeParticipant SessionGetSessionsResponseDataSessionsType = "participant" )
func (SessionGetSessionsResponseDataSessionsType) IsKnown ¶
func (r SessionGetSessionsResponseDataSessionsType) IsKnown() bool
type SessionService ¶
type SessionService struct {
Options []option.RequestOption
}
SessionService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSessionService method instead.
func NewSessionService ¶
func NewSessionService(opts ...option.RequestOption) (r *SessionService)
NewSessionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SessionService) GenerateSummaryOfTranscripts ¶
func (r *SessionService) GenerateSummaryOfTranscripts(ctx context.Context, appID string, sessionID string, body SessionGenerateSummaryOfTranscriptsParams, opts ...option.RequestOption) (err error)
Trigger Summary generation of Transcripts for the session ID.
func (*SessionService) GetParticipantDataFromPeerID ¶
func (r *SessionService) GetParticipantDataFromPeerID(ctx context.Context, appID string, peerID string, params SessionGetParticipantDataFromPeerIDParams, opts ...option.RequestOption) (res *SessionGetParticipantDataFromPeerIDResponse, err error)
Returns details of the given peer ID along with call statistics for the given session ID.
func (*SessionService) GetSessionChat ¶
func (r *SessionService) GetSessionChat(ctx context.Context, appID string, sessionID string, query SessionGetSessionChatParams, opts ...option.RequestOption) (res *SessionGetSessionChatResponse, err error)
Returns a URL to download all chat messages of the session ID in CSV format.
func (*SessionService) GetSessionDetails ¶
func (r *SessionService) GetSessionDetails(ctx context.Context, appID string, sessionID string, params SessionGetSessionDetailsParams, opts ...option.RequestOption) (res *SessionGetSessionDetailsResponse, err error)
Returns data of the given session ID including recording details.
func (*SessionService) GetSessionParticipantDetails ¶
func (r *SessionService) GetSessionParticipantDetails(ctx context.Context, appID string, sessionID string, participantID string, params SessionGetSessionParticipantDetailsParams, opts ...option.RequestOption) (res *SessionGetSessionParticipantDetailsResponse, err error)
Returns details of the given participant ID along with call statistics for the given session ID.
func (*SessionService) GetSessionParticipants ¶
func (r *SessionService) GetSessionParticipants(ctx context.Context, appID string, sessionID string, params SessionGetSessionParticipantsParams, opts ...option.RequestOption) (res *SessionGetSessionParticipantsResponse, err error)
Returns a list of participants for the given session ID.
func (*SessionService) GetSessionSummary ¶
func (r *SessionService) GetSessionSummary(ctx context.Context, appID string, sessionID string, query SessionGetSessionSummaryParams, opts ...option.RequestOption) (res *SessionGetSessionSummaryResponse, err error)
Returns a Summary URL to download the Summary of Transcripts for the session ID as plain text.
func (*SessionService) GetSessionTranscripts ¶
func (r *SessionService) GetSessionTranscripts(ctx context.Context, appID string, sessionID string, query SessionGetSessionTranscriptsParams, opts ...option.RequestOption) (res *SessionGetSessionTranscriptsResponse, err error)
Returns a URL to download the transcript for the session ID in CSV format.
func (*SessionService) GetSessions ¶
func (r *SessionService) GetSessions(ctx context.Context, appID string, params SessionGetSessionsParams, opts ...option.RequestOption) (res *SessionGetSessionsResponse, err error)
Returns details of all sessions of an App.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.
type SubscriptionFrequency ¶
type SubscriptionFrequency = shared.SubscriptionFrequency
How often the subscription is renewed automatically.
This is an alias to an internal type.
type SubscriptionParam ¶
type SubscriptionParam = shared.SubscriptionParam
This is an alias to an internal type.
type SubscriptionState ¶
type SubscriptionState = shared.SubscriptionState
The state that the subscription is in.
This is an alias to an internal type.
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectString ¶
type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.
type WebhookDeleteWebhookResponse ¶
type WebhookDeleteWebhookResponse struct {
Data WebhookDeleteWebhookResponseData `json:"data" api:"required"`
Success bool `json:"success" api:"required"`
JSON webhookDeleteWebhookResponseJSON `json:"-"`
}
func (*WebhookDeleteWebhookResponse) UnmarshalJSON ¶
func (r *WebhookDeleteWebhookResponse) UnmarshalJSON(data []byte) (err error)
type WebhookDeleteWebhookResponseData ¶
type WebhookDeleteWebhookResponseData struct {
// ID of the webhook
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp when this webhook was created
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Set to true if the webhook is active
Enabled bool `json:"enabled" api:"required"`
// Events this webhook will send updates for
Events []WebhookDeleteWebhookResponseDataEvent `json:"events" api:"required"`
// Name of the webhook
Name string `json:"name" api:"required"`
// Timestamp when this webhook was updated
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// URL the webhook will send events to
URL string `json:"url" api:"required" format:"uri"`
JSON webhookDeleteWebhookResponseDataJSON `json:"-"`
}
func (*WebhookDeleteWebhookResponseData) UnmarshalJSON ¶
func (r *WebhookDeleteWebhookResponseData) UnmarshalJSON(data []byte) (err error)
type WebhookDeleteWebhookResponseDataEvent ¶
type WebhookDeleteWebhookResponseDataEvent string
const ( WebhookDeleteWebhookResponseDataEventMeetingStarted WebhookDeleteWebhookResponseDataEvent = "meeting.started" WebhookDeleteWebhookResponseDataEventMeetingEnded WebhookDeleteWebhookResponseDataEvent = "meeting.ended" WebhookDeleteWebhookResponseDataEventMeetingParticipantJoined WebhookDeleteWebhookResponseDataEvent = "meeting.participantJoined" WebhookDeleteWebhookResponseDataEventMeetingParticipantLeft WebhookDeleteWebhookResponseDataEvent = "meeting.participantLeft" WebhookDeleteWebhookResponseDataEventMeetingChatSynced WebhookDeleteWebhookResponseDataEvent = "meeting.chatSynced" WebhookDeleteWebhookResponseDataEventRecordingStatusUpdate WebhookDeleteWebhookResponseDataEvent = "recording.statusUpdate" WebhookDeleteWebhookResponseDataEventLivestreamingStatusUpdate WebhookDeleteWebhookResponseDataEvent = "livestreaming.statusUpdate" WebhookDeleteWebhookResponseDataEventMeetingTranscript WebhookDeleteWebhookResponseDataEvent = "meeting.transcript" WebhookDeleteWebhookResponseDataEventMeetingSummary WebhookDeleteWebhookResponseDataEvent = "meeting.summary" )
func (WebhookDeleteWebhookResponseDataEvent) IsKnown ¶
func (r WebhookDeleteWebhookResponseDataEvent) IsKnown() bool
type WebhookEditWebhookParams ¶
type WebhookEditWebhookParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
Enabled param.Field[bool] `json:"enabled"`
// Events that the webhook will get triggered by
Events param.Field[[]WebhookEditWebhookParamsEvent] `json:"events"`
// Name of the webhook
Name param.Field[string] `json:"name"`
// URL the webhook will send events to
URL param.Field[string] `json:"url" format:"uri"`
}
func (WebhookEditWebhookParams) MarshalJSON ¶
func (r WebhookEditWebhookParams) MarshalJSON() (data []byte, err error)
type WebhookEditWebhookParamsEvent ¶
type WebhookEditWebhookParamsEvent string
const ( WebhookEditWebhookParamsEventMeetingStarted WebhookEditWebhookParamsEvent = "meeting.started" WebhookEditWebhookParamsEventMeetingEnded WebhookEditWebhookParamsEvent = "meeting.ended" WebhookEditWebhookParamsEventMeetingParticipantJoined WebhookEditWebhookParamsEvent = "meeting.participantJoined" WebhookEditWebhookParamsEventMeetingParticipantLeft WebhookEditWebhookParamsEvent = "meeting.participantLeft" WebhookEditWebhookParamsEventRecordingStatusUpdate WebhookEditWebhookParamsEvent = "recording.statusUpdate" WebhookEditWebhookParamsEventLivestreamingStatusUpdate WebhookEditWebhookParamsEvent = "livestreaming.statusUpdate" WebhookEditWebhookParamsEventMeetingChatSynced WebhookEditWebhookParamsEvent = "meeting.chatSynced" WebhookEditWebhookParamsEventMeetingTranscript WebhookEditWebhookParamsEvent = "meeting.transcript" WebhookEditWebhookParamsEventMeetingSummary WebhookEditWebhookParamsEvent = "meeting.summary" )
func (WebhookEditWebhookParamsEvent) IsKnown ¶
func (r WebhookEditWebhookParamsEvent) IsKnown() bool
type WebhookEditWebhookResponse ¶
type WebhookEditWebhookResponse struct {
Data WebhookEditWebhookResponseData `json:"data" api:"required"`
Success bool `json:"success" api:"required"`
JSON webhookEditWebhookResponseJSON `json:"-"`
}
func (*WebhookEditWebhookResponse) UnmarshalJSON ¶
func (r *WebhookEditWebhookResponse) UnmarshalJSON(data []byte) (err error)
type WebhookEditWebhookResponseData ¶
type WebhookEditWebhookResponseData struct {
// ID of the webhook
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp when this webhook was created
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Set to true if the webhook is active
Enabled bool `json:"enabled" api:"required"`
// Events this webhook will send updates for
Events []WebhookEditWebhookResponseDataEvent `json:"events" api:"required"`
// Name of the webhook
Name string `json:"name" api:"required"`
// Timestamp when this webhook was updated
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// URL the webhook will send events to
URL string `json:"url" api:"required" format:"uri"`
JSON webhookEditWebhookResponseDataJSON `json:"-"`
}
func (*WebhookEditWebhookResponseData) UnmarshalJSON ¶
func (r *WebhookEditWebhookResponseData) UnmarshalJSON(data []byte) (err error)
type WebhookEditWebhookResponseDataEvent ¶
type WebhookEditWebhookResponseDataEvent string
const ( WebhookEditWebhookResponseDataEventMeetingStarted WebhookEditWebhookResponseDataEvent = "meeting.started" WebhookEditWebhookResponseDataEventMeetingEnded WebhookEditWebhookResponseDataEvent = "meeting.ended" WebhookEditWebhookResponseDataEventMeetingParticipantJoined WebhookEditWebhookResponseDataEvent = "meeting.participantJoined" WebhookEditWebhookResponseDataEventMeetingParticipantLeft WebhookEditWebhookResponseDataEvent = "meeting.participantLeft" WebhookEditWebhookResponseDataEventMeetingChatSynced WebhookEditWebhookResponseDataEvent = "meeting.chatSynced" WebhookEditWebhookResponseDataEventRecordingStatusUpdate WebhookEditWebhookResponseDataEvent = "recording.statusUpdate" WebhookEditWebhookResponseDataEventLivestreamingStatusUpdate WebhookEditWebhookResponseDataEvent = "livestreaming.statusUpdate" WebhookEditWebhookResponseDataEventMeetingTranscript WebhookEditWebhookResponseDataEvent = "meeting.transcript" WebhookEditWebhookResponseDataEventMeetingSummary WebhookEditWebhookResponseDataEvent = "meeting.summary" )
func (WebhookEditWebhookResponseDataEvent) IsKnown ¶
func (r WebhookEditWebhookResponseDataEvent) IsKnown() bool
type WebhookGetWebhookByIDResponse ¶
type WebhookGetWebhookByIDResponse struct {
Data WebhookGetWebhookByIDResponseData `json:"data" api:"required"`
Success bool `json:"success" api:"required"`
JSON webhookGetWebhookByIDResponseJSON `json:"-"`
}
func (*WebhookGetWebhookByIDResponse) UnmarshalJSON ¶
func (r *WebhookGetWebhookByIDResponse) UnmarshalJSON(data []byte) (err error)
type WebhookGetWebhookByIDResponseData ¶
type WebhookGetWebhookByIDResponseData struct {
// ID of the webhook
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp when this webhook was created
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Set to true if the webhook is active
Enabled bool `json:"enabled" api:"required"`
// Events this webhook will send updates for
Events []WebhookGetWebhookByIDResponseDataEvent `json:"events" api:"required"`
// Name of the webhook
Name string `json:"name" api:"required"`
// Timestamp when this webhook was updated
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// URL the webhook will send events to
URL string `json:"url" api:"required" format:"uri"`
JSON webhookGetWebhookByIDResponseDataJSON `json:"-"`
}
func (*WebhookGetWebhookByIDResponseData) UnmarshalJSON ¶
func (r *WebhookGetWebhookByIDResponseData) UnmarshalJSON(data []byte) (err error)
type WebhookGetWebhookByIDResponseDataEvent ¶
type WebhookGetWebhookByIDResponseDataEvent string
const ( WebhookGetWebhookByIDResponseDataEventMeetingStarted WebhookGetWebhookByIDResponseDataEvent = "meeting.started" WebhookGetWebhookByIDResponseDataEventMeetingEnded WebhookGetWebhookByIDResponseDataEvent = "meeting.ended" WebhookGetWebhookByIDResponseDataEventMeetingParticipantJoined WebhookGetWebhookByIDResponseDataEvent = "meeting.participantJoined" WebhookGetWebhookByIDResponseDataEventMeetingParticipantLeft WebhookGetWebhookByIDResponseDataEvent = "meeting.participantLeft" WebhookGetWebhookByIDResponseDataEventMeetingChatSynced WebhookGetWebhookByIDResponseDataEvent = "meeting.chatSynced" WebhookGetWebhookByIDResponseDataEventRecordingStatusUpdate WebhookGetWebhookByIDResponseDataEvent = "recording.statusUpdate" WebhookGetWebhookByIDResponseDataEventLivestreamingStatusUpdate WebhookGetWebhookByIDResponseDataEvent = "livestreaming.statusUpdate" WebhookGetWebhookByIDResponseDataEventMeetingTranscript WebhookGetWebhookByIDResponseDataEvent = "meeting.transcript" WebhookGetWebhookByIDResponseDataEventMeetingSummary WebhookGetWebhookByIDResponseDataEvent = "meeting.summary" )
func (WebhookGetWebhookByIDResponseDataEvent) IsKnown ¶
func (r WebhookGetWebhookByIDResponseDataEvent) IsKnown() bool
type WebhookGetWebhooksResponse ¶
type WebhookGetWebhooksResponse struct {
Data []WebhookGetWebhooksResponseData `json:"data" api:"required"`
Success bool `json:"success" api:"required"`
JSON webhookGetWebhooksResponseJSON `json:"-"`
}
func (*WebhookGetWebhooksResponse) UnmarshalJSON ¶
func (r *WebhookGetWebhooksResponse) UnmarshalJSON(data []byte) (err error)
type WebhookGetWebhooksResponseData ¶
type WebhookGetWebhooksResponseData struct {
// ID of the webhook
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp when this webhook was created
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Set to true if the webhook is active
Enabled bool `json:"enabled" api:"required"`
// Events this webhook will send updates for
Events []WebhookGetWebhooksResponseDataEvent `json:"events" api:"required"`
// Name of the webhook
Name string `json:"name" api:"required"`
// Timestamp when this webhook was updated
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// URL the webhook will send events to
URL string `json:"url" api:"required" format:"uri"`
JSON webhookGetWebhooksResponseDataJSON `json:"-"`
}
func (*WebhookGetWebhooksResponseData) UnmarshalJSON ¶
func (r *WebhookGetWebhooksResponseData) UnmarshalJSON(data []byte) (err error)
type WebhookGetWebhooksResponseDataEvent ¶
type WebhookGetWebhooksResponseDataEvent string
const ( WebhookGetWebhooksResponseDataEventMeetingStarted WebhookGetWebhooksResponseDataEvent = "meeting.started" WebhookGetWebhooksResponseDataEventMeetingEnded WebhookGetWebhooksResponseDataEvent = "meeting.ended" WebhookGetWebhooksResponseDataEventMeetingParticipantJoined WebhookGetWebhooksResponseDataEvent = "meeting.participantJoined" WebhookGetWebhooksResponseDataEventMeetingParticipantLeft WebhookGetWebhooksResponseDataEvent = "meeting.participantLeft" WebhookGetWebhooksResponseDataEventMeetingChatSynced WebhookGetWebhooksResponseDataEvent = "meeting.chatSynced" WebhookGetWebhooksResponseDataEventRecordingStatusUpdate WebhookGetWebhooksResponseDataEvent = "recording.statusUpdate" WebhookGetWebhooksResponseDataEventLivestreamingStatusUpdate WebhookGetWebhooksResponseDataEvent = "livestreaming.statusUpdate" WebhookGetWebhooksResponseDataEventMeetingTranscript WebhookGetWebhooksResponseDataEvent = "meeting.transcript" WebhookGetWebhooksResponseDataEventMeetingSummary WebhookGetWebhooksResponseDataEvent = "meeting.summary" )
func (WebhookGetWebhooksResponseDataEvent) IsKnown ¶
func (r WebhookGetWebhooksResponseDataEvent) IsKnown() bool
type WebhookNewWebhookParams ¶
type WebhookNewWebhookParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Events that this webhook will get triggered by
Events param.Field[[]WebhookNewWebhookParamsEvent] `json:"events" api:"required"`
// Name of the webhook
Name param.Field[string] `json:"name" api:"required"`
// URL this webhook will send events to
URL param.Field[string] `json:"url" api:"required" format:"uri"`
// Set whether or not the webhook should be active when created
Enabled param.Field[bool] `json:"enabled"`
}
func (WebhookNewWebhookParams) MarshalJSON ¶
func (r WebhookNewWebhookParams) MarshalJSON() (data []byte, err error)
type WebhookNewWebhookParamsEvent ¶
type WebhookNewWebhookParamsEvent string
const ( WebhookNewWebhookParamsEventMeetingStarted WebhookNewWebhookParamsEvent = "meeting.started" WebhookNewWebhookParamsEventMeetingEnded WebhookNewWebhookParamsEvent = "meeting.ended" WebhookNewWebhookParamsEventMeetingParticipantJoined WebhookNewWebhookParamsEvent = "meeting.participantJoined" WebhookNewWebhookParamsEventMeetingParticipantLeft WebhookNewWebhookParamsEvent = "meeting.participantLeft" WebhookNewWebhookParamsEventMeetingChatSynced WebhookNewWebhookParamsEvent = "meeting.chatSynced" WebhookNewWebhookParamsEventRecordingStatusUpdate WebhookNewWebhookParamsEvent = "recording.statusUpdate" WebhookNewWebhookParamsEventLivestreamingStatusUpdate WebhookNewWebhookParamsEvent = "livestreaming.statusUpdate" WebhookNewWebhookParamsEventMeetingTranscript WebhookNewWebhookParamsEvent = "meeting.transcript" WebhookNewWebhookParamsEventMeetingSummary WebhookNewWebhookParamsEvent = "meeting.summary" )
func (WebhookNewWebhookParamsEvent) IsKnown ¶
func (r WebhookNewWebhookParamsEvent) IsKnown() bool
type WebhookNewWebhookResponse ¶
type WebhookNewWebhookResponse struct {
Data WebhookNewWebhookResponseData `json:"data" api:"required"`
Success bool `json:"success" api:"required"`
JSON webhookNewWebhookResponseJSON `json:"-"`
}
func (*WebhookNewWebhookResponse) UnmarshalJSON ¶
func (r *WebhookNewWebhookResponse) UnmarshalJSON(data []byte) (err error)
type WebhookNewWebhookResponseData ¶
type WebhookNewWebhookResponseData struct {
// ID of the webhook
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp when this webhook was created
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Set to true if the webhook is active
Enabled bool `json:"enabled" api:"required"`
// Events this webhook will send updates for
Events []WebhookNewWebhookResponseDataEvent `json:"events" api:"required"`
// Name of the webhook
Name string `json:"name" api:"required"`
// Timestamp when this webhook was updated
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// URL the webhook will send events to
URL string `json:"url" api:"required" format:"uri"`
JSON webhookNewWebhookResponseDataJSON `json:"-"`
}
func (*WebhookNewWebhookResponseData) UnmarshalJSON ¶
func (r *WebhookNewWebhookResponseData) UnmarshalJSON(data []byte) (err error)
type WebhookNewWebhookResponseDataEvent ¶
type WebhookNewWebhookResponseDataEvent string
const ( WebhookNewWebhookResponseDataEventMeetingStarted WebhookNewWebhookResponseDataEvent = "meeting.started" WebhookNewWebhookResponseDataEventMeetingEnded WebhookNewWebhookResponseDataEvent = "meeting.ended" WebhookNewWebhookResponseDataEventMeetingParticipantJoined WebhookNewWebhookResponseDataEvent = "meeting.participantJoined" WebhookNewWebhookResponseDataEventMeetingParticipantLeft WebhookNewWebhookResponseDataEvent = "meeting.participantLeft" WebhookNewWebhookResponseDataEventMeetingChatSynced WebhookNewWebhookResponseDataEvent = "meeting.chatSynced" WebhookNewWebhookResponseDataEventRecordingStatusUpdate WebhookNewWebhookResponseDataEvent = "recording.statusUpdate" WebhookNewWebhookResponseDataEventLivestreamingStatusUpdate WebhookNewWebhookResponseDataEvent = "livestreaming.statusUpdate" WebhookNewWebhookResponseDataEventMeetingTranscript WebhookNewWebhookResponseDataEvent = "meeting.transcript" WebhookNewWebhookResponseDataEventMeetingSummary WebhookNewWebhookResponseDataEvent = "meeting.summary" )
func (WebhookNewWebhookResponseDataEvent) IsKnown ¶
func (r WebhookNewWebhookResponseDataEvent) IsKnown() bool
type WebhookReplaceWebhookParams ¶
type WebhookReplaceWebhookParams struct {
// The account identifier tag.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Events that this webhook will get triggered by
Events param.Field[[]WebhookReplaceWebhookParamsEvent] `json:"events" api:"required"`
// Name of the webhook
Name param.Field[string] `json:"name" api:"required"`
// URL this webhook will send events to
URL param.Field[string] `json:"url" api:"required" format:"uri"`
// Set whether or not the webhook should be active when created
Enabled param.Field[bool] `json:"enabled"`
}
func (WebhookReplaceWebhookParams) MarshalJSON ¶
func (r WebhookReplaceWebhookParams) MarshalJSON() (data []byte, err error)
type WebhookReplaceWebhookParamsEvent ¶
type WebhookReplaceWebhookParamsEvent string
const ( WebhookReplaceWebhookParamsEventMeetingStarted WebhookReplaceWebhookParamsEvent = "meeting.started" WebhookReplaceWebhookParamsEventMeetingEnded WebhookReplaceWebhookParamsEvent = "meeting.ended" WebhookReplaceWebhookParamsEventMeetingParticipantJoined WebhookReplaceWebhookParamsEvent = "meeting.participantJoined" WebhookReplaceWebhookParamsEventMeetingParticipantLeft WebhookReplaceWebhookParamsEvent = "meeting.participantLeft" WebhookReplaceWebhookParamsEventMeetingChatSynced WebhookReplaceWebhookParamsEvent = "meeting.chatSynced" WebhookReplaceWebhookParamsEventRecordingStatusUpdate WebhookReplaceWebhookParamsEvent = "recording.statusUpdate" WebhookReplaceWebhookParamsEventLivestreamingStatusUpdate WebhookReplaceWebhookParamsEvent = "livestreaming.statusUpdate" WebhookReplaceWebhookParamsEventMeetingTranscript WebhookReplaceWebhookParamsEvent = "meeting.transcript" WebhookReplaceWebhookParamsEventMeetingSummary WebhookReplaceWebhookParamsEvent = "meeting.summary" )
func (WebhookReplaceWebhookParamsEvent) IsKnown ¶
func (r WebhookReplaceWebhookParamsEvent) IsKnown() bool
type WebhookReplaceWebhookResponse ¶
type WebhookReplaceWebhookResponse struct {
Data WebhookReplaceWebhookResponseData `json:"data" api:"required"`
Success bool `json:"success" api:"required"`
JSON webhookReplaceWebhookResponseJSON `json:"-"`
}
func (*WebhookReplaceWebhookResponse) UnmarshalJSON ¶
func (r *WebhookReplaceWebhookResponse) UnmarshalJSON(data []byte) (err error)
type WebhookReplaceWebhookResponseData ¶
type WebhookReplaceWebhookResponseData struct {
// ID of the webhook
ID string `json:"id" api:"required" format:"uuid"`
// Timestamp when this webhook was created
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
// Set to true if the webhook is active
Enabled bool `json:"enabled" api:"required"`
// Events this webhook will send updates for
Events []WebhookReplaceWebhookResponseDataEvent `json:"events" api:"required"`
// Name of the webhook
Name string `json:"name" api:"required"`
// Timestamp when this webhook was updated
UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
// URL the webhook will send events to
URL string `json:"url" api:"required" format:"uri"`
JSON webhookReplaceWebhookResponseDataJSON `json:"-"`
}
func (*WebhookReplaceWebhookResponseData) UnmarshalJSON ¶
func (r *WebhookReplaceWebhookResponseData) UnmarshalJSON(data []byte) (err error)
type WebhookReplaceWebhookResponseDataEvent ¶
type WebhookReplaceWebhookResponseDataEvent string
const ( WebhookReplaceWebhookResponseDataEventMeetingStarted WebhookReplaceWebhookResponseDataEvent = "meeting.started" WebhookReplaceWebhookResponseDataEventMeetingEnded WebhookReplaceWebhookResponseDataEvent = "meeting.ended" WebhookReplaceWebhookResponseDataEventMeetingParticipantJoined WebhookReplaceWebhookResponseDataEvent = "meeting.participantJoined" WebhookReplaceWebhookResponseDataEventMeetingParticipantLeft WebhookReplaceWebhookResponseDataEvent = "meeting.participantLeft" WebhookReplaceWebhookResponseDataEventMeetingChatSynced WebhookReplaceWebhookResponseDataEvent = "meeting.chatSynced" WebhookReplaceWebhookResponseDataEventRecordingStatusUpdate WebhookReplaceWebhookResponseDataEvent = "recording.statusUpdate" WebhookReplaceWebhookResponseDataEventLivestreamingStatusUpdate WebhookReplaceWebhookResponseDataEvent = "livestreaming.statusUpdate" WebhookReplaceWebhookResponseDataEventMeetingTranscript WebhookReplaceWebhookResponseDataEvent = "meeting.transcript" WebhookReplaceWebhookResponseDataEventMeetingSummary WebhookReplaceWebhookResponseDataEvent = "meeting.summary" )
func (WebhookReplaceWebhookResponseDataEvent) IsKnown ¶
func (r WebhookReplaceWebhookResponseDataEvent) IsKnown() bool
type WebhookService ¶
type WebhookService struct {
Options []option.RequestOption
}
WebhookService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewWebhookService method instead.
func NewWebhookService ¶
func NewWebhookService(opts ...option.RequestOption) (r *WebhookService)
NewWebhookService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*WebhookService) DeleteWebhook ¶
func (r *WebhookService) DeleteWebhook(ctx context.Context, appID string, webhookID string, body WebhookDeleteWebhookParams, opts ...option.RequestOption) (res *WebhookDeleteWebhookResponse, err error)
Removes a webhook for the given webhook ID.
func (*WebhookService) EditWebhook ¶
func (r *WebhookService) EditWebhook(ctx context.Context, appID string, webhookID string, params WebhookEditWebhookParams, opts ...option.RequestOption) (res *WebhookEditWebhookResponse, err error)
Edits the webhook details for the given webhook ID.
func (*WebhookService) GetWebhookByID ¶
func (r *WebhookService) GetWebhookByID(ctx context.Context, appID string, webhookID string, query WebhookGetWebhookByIDParams, opts ...option.RequestOption) (res *WebhookGetWebhookByIDResponse, err error)
Returns webhook details for the given webhook ID.
func (*WebhookService) GetWebhooks ¶
func (r *WebhookService) GetWebhooks(ctx context.Context, appID string, query WebhookGetWebhooksParams, opts ...option.RequestOption) (res *WebhookGetWebhooksResponse, err error)
Returns details of all webhooks for an App.
func (*WebhookService) NewWebhook ¶
func (r *WebhookService) NewWebhook(ctx context.Context, appID string, params WebhookNewWebhookParams, opts ...option.RequestOption) (res *WebhookNewWebhookResponse, err error)
Adds a new webhook to an App.
func (*WebhookService) ReplaceWebhook ¶
func (r *WebhookService) ReplaceWebhook(ctx context.Context, appID string, webhookID string, params WebhookReplaceWebhookParams, opts ...option.RequestOption) (res *WebhookReplaceWebhookResponse, err error)
Replace all details for the given webhook ID.