Documentation
¶
Overview ¶
Package models provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.
Index ¶
- func GetEventType(rawEvent []byte) string
- type APIError
- type AbsentMetric
- type AcceptCallRequest
- type AcceptCallResponse
- type AppEventResponse
- type AppUpdatedEvent
- type Audience
- type AudioSettingsRequest
- type AudioSettingsRequestDefaultDevice
- type AudioSettingsResponse
- type AudioSettingsResponseDefaultDevice
- type BackstageSettingsRequest
- type BackstageSettingsResponse
- type BlockUserJSONRequestBody
- type BlockUserRequest
- type BlockUserResponse
- type BlockedUserEvent
- type Bound
- type BroadcastDigest
- type BroadcastInfo
- type BroadcastSegment
- type BroadcastSettingsRequest
- type BroadcastSettingsResponse
- type CallAcceptedEvent
- type CallClosedCaption
- type CallClosedCaptionsFailedEvent
- type CallClosedCaptionsStartedEvent
- type CallClosedCaptionsStoppedEvent
- type CallCreatedEvent
- type CallDTMFEvent
- type CallDeletedEvent
- type CallDurationReport
- type CallDurationReportResponse
- type CallEndedEvent
- type CallFrameRecordingFailedEvent
- type CallFrameRecordingFrameReadyEvent
- type CallFrameRecordingStartedEvent
- type CallFrameRecordingStoppedEvent
- type CallHLSBroadcastingFailedEvent
- type CallHLSBroadcastingStartedEvent
- type CallHLSBroadcastingStoppedEvent
- type CallIngressResponse
- type CallLevelEventPayload
- type CallLiveStartedEvent
- type CallMemberAddedEvent
- type CallMemberRemovedEvent
- type CallMemberUpdatedEvent
- type CallMemberUpdatedPermissionEvent
- type CallMissedEvent
- type CallModerationBlurEvent
- type CallModerationWarningEvent
- type CallNotificationEvent
- type CallParticipantCountReport
- type CallParticipantCountReportResponse
- type CallParticipantResponse
- type CallParticipantTimeline
- type CallReactionEvent
- type CallRecording
- type CallRecordingFailedEvent
- type CallRecordingFailedEventRecordingType
- type CallRecordingReadyEvent
- type CallRecordingReadyEventRecordingType
- type CallRecordingStartedEvent
- type CallRecordingStartedEventRecordingType
- type CallRecordingStoppedEvent
- type CallRecordingStoppedEventRecordingType
- type CallRejectedEvent
- type CallReportResponse
- type CallRequest
- type CallResponse
- type CallRingEvent
- type CallRtmpBroadcastFailedEvent
- type CallRtmpBroadcastStartedEvent
- type CallRtmpBroadcastStoppedEvent
- type CallSessionEndedEvent
- type CallSessionParticipantCountsUpdatedEvent
- type CallSessionParticipantJoinedEvent
- type CallSessionParticipantLeftEvent
- type CallSessionResponse
- type CallSessionStartedEvent
- type CallSettingsRequest
- type CallSettingsResponse
- type CallStateResponseFields
- type CallStatsLocation
- type CallStatsMapLocation
- type CallStatsMapPublisher
- type CallStatsMapPublishers
- type CallStatsMapSFUs
- type CallStatsMapSubscriber
- type CallStatsMapSubscribers
- type CallStatsParticipant
- type CallStatsParticipantCounts
- type CallStatsParticipantSession
- type CallStatsReportReadyEvent
- type CallStatsReportSummaryResponse
- type CallStatsSessionResponse
- type CallTranscription
- type CallTranscriptionFailedEvent
- type CallTranscriptionReadyEvent
- type CallTranscriptionStartedEvent
- type CallTranscriptionStoppedEvent
- type CallUpdatedEvent
- type CallUserFeedbackSubmittedEvent
- type CallUserMutedEvent
- type CallsPerDayReport
- type CallsPerDayReportResponse
- type ChatActivityStatsResponse
- type ChatPreferencesResponse
- type ClientEvent
- type ClosedCaptionEvent
- type CollectUserFeedbackJSONRequestBody
- type CollectUserFeedbackRequest
- type CollectUserFeedbackResponse
- type CompositeRecordingResponse
- type ConcurrencyMinute
- type ConnectUserDetailsRequest
- type ConnectedEvent
- type ConnectionErrorEvent
- type CoordinatesResponse
- type CountByMinuteResponse
- type Coverage
- type CreateDeviceJSONRequestBody
- type CreateDeviceRequest
- type CreateDeviceRequestPushProvider
- type CreateGuestJSONRequestBody
- type CreateGuestRequest
- type CreateGuestResponse
- type Credentials
- type CustomVideoEvent
- type DailyAggregateCallDurationReportResponse
- type DailyAggregateCallParticipantCountReportResponse
- type DailyAggregateCallsPerDayReportResponse
- type DailyAggregateQualityScoreReportResponse
- type DailyAggregateSDKUsageReportResponse
- type DailyAggregateUserFeedbackReportResponse
- type DeleteCallJSONRequestBody
- type DeleteCallRequest
- type DeleteCallResponse
- type DeleteDeviceParams
- type DeleteRecordingResponse
- type DeleteTranscriptionResponse
- type DeliveryZoneSegment
- type DeviceResponse
- type EdgeResponse
- type EgressHLSResponse
- type EgressRTMPResponse
- type EgressResponse
- type EncodingProfile
- type EncryptionSettingsRequest
- type EncryptionSettingsRequestMode
- type EncryptionSettingsResponse
- type EncryptionSettingsResponseMode
- type EndCallRequest
- type EndCallResponse
- type FeedsPreferencesResponse
- type FileUploadConfig
- type FrameRecordingResponse
- type FrameRecordingSettingsRequest
- type FrameRecordingSettingsRequestMode
- type FrameRecordingSettingsRequestQuality
- type FrameRecordingSettingsResponse
- type FrameRecordingSettingsResponseMode
- type GeofenceSettingsRequest
- type GeofenceSettingsResponse
- type GetCallParams
- type GetCallParticipantSessionMetricsParams
- type GetCallParticipantSessionMetricsResponse
- type GetCallReportParams
- type GetCallReportResponse
- type GetCallResponse
- type GetCallSessionParticipantStatsDetailsParams
- type GetCallSessionParticipantStatsDetailsResponse
- type GetCallSessionParticipantStatsTimelineParams
- type GetCallStatsMapParams
- type GetEdgesResponse
- type GetOrCreateCallJSONRequestBody
- type GetOrCreateCallParams
- type GetOrCreateCallRequest
- type GetOrCreateCallResponse
- type GoLiveJSONRequestBody
- type GoLiveRequest
- type GoLiveResponse
- type GroupedStatsResponse
- type HLSSettingsRequest
- type HLSSettingsRequestQualityTracks
- type HLSSettingsResponse
- type HealthCheckEvent
- type ICEServerResponse
- type Incident
- type IndividualRecordingResponse
- type IndividualRecordingSettingsRequest
- type IndividualRecordingSettingsRequestMode
- type IndividualRecordingSettingsRequestOutputTypes
- type IndividualRecordingSettingsResponse
- type IndividualRecordingSettingsResponseMode
- type IngressAudioEncodingOptionsRequest
- type IngressAudioEncodingOptionsRequestChannels
- type IngressAudioEncodingResponse
- type IngressErrorEvent
- type IngressSettingsRequest
- type IngressSettingsResponse
- type IngressSourceRequest
- type IngressSourceRequestFps
- type IngressSourceResponse
- type IngressStartedEvent
- type IngressStoppedEvent
- type IngressVideoEncodingOptionsRequest
- type IngressVideoEncodingResponse
- type IngressVideoLayerRequest
- type IngressVideoLayerRequestCodec
- type IngressVideoLayerResponse
- type JoinCallJSONRequestBody
- type JoinCallParams
- type JoinCallRequest
- type JoinCallResponse
- type Joins
- type KickUserJSONRequestBody
- type KickUserRequest
- type KickUserResponse
- type KickedUserEvent
- type LayoutSettingsRequest
- type LayoutSettingsRequestName
- type LimitsSettingsRequest
- type LimitsSettingsResponse
- type ListDevicesResponse
- type ListRecordingsResponse
- type ListTranscriptionsResponse
- type LocationResponse
- type MemberRequest
- type MemberResponse
- type MessageStatsResponse
- type MetricDescriptor
- type MetricThreshold
- type MetricTimeSeries
- type MetricsPct
- type MuteUsersJSONRequestBody
- type MuteUsersRequest
- type MuteUsersResponse
- type NetworkMetricsReportResponse
- type NoiseCancellationSettings
- type NoiseCancellationSettingsMode
- type OwnCapability
- type OwnUserResponse
- type ParticipantCountByMinuteResponse
- type ParticipantCountOverTimeResponse
- type ParticipantReportResponse
- type ParticipantSeriesPublisherStats
- type ParticipantSeriesSubscriberStats
- type ParticipantSeriesSubscriptionTrackMetrics
- type ParticipantSeriesTimeframe
- type ParticipantSeriesTrackMetrics
- type ParticipantSeriesUserStats
- type ParticipantSessionDetails
- type PerSDKUsageReport
- type Percentiles
- type PermissionRequestEvent
- type PinRequest
- type PinResponse
- type PoorByCause
- type PoorTail
- type PrivacySettingsResponse
- type PublishedTrackFlags
- type PublishedTrackMetrics
- type PublisherSession
- type PublisherStatsResponse
- type PushPreferencesResponse
- type Quality
- type QualityScoreReport
- type QualityScoreReportResponse
- type QueryAggregateCallStatsJSONRequestBody
- type QueryAggregateCallStatsRequest
- type QueryAggregateCallStatsResponse
- type QueryCallMembersJSONRequestBody
- type QueryCallMembersRequest
- type QueryCallMembersResponse
- type QueryCallParticipantSessionsParams
- type QueryCallParticipantSessionsResponse
- type QueryCallParticipantsJSONRequestBody
- type QueryCallParticipantsParams
- type QueryCallParticipantsRequest
- type QueryCallParticipantsResponse
- type QueryCallSessionParticipantStatsParams
- type QueryCallSessionParticipantStatsResponse
- type QueryCallSessionParticipantStatsTimelineResponse
- type QueryCallSessionStatsJSONRequestBody
- type QueryCallSessionStatsRequest
- type QueryCallSessionStatsResponse
- type QueryCallStatsJSONRequestBody
- type QueryCallStatsMapResponse
- type QueryCallStatsRequest
- type QueryCallStatsResponse
- type QueryCallsJSONRequestBody
- type QueryCallsParams
- type QueryCallsRequest
- type QueryCallsResponse
- type RTMPBroadcastRequest
- type RTMPBroadcastRequestQuality
- type RTMPIngress
- type RTMPSettingsRequest
- type RTMPSettingsRequestQuality
- type RTMPSettingsResponse
- type RawRecordingResponse
- type RawRecordingSettingsRequest
- type RawRecordingSettingsRequestMode
- type RawRecordingSettingsResponse
- type RawRecordingSettingsResponseMode
- type RecordSettingsRequest
- type RecordSettingsRequestMode
- type RecordSettingsRequestQuality
- type RecordSettingsResponse
- type RejectCallJSONRequestBody
- type RejectCallRequest
- type RejectCallResponse
- type ReportByHistogramBucket
- type ReportClientCallEventJSONRequestBody
- type ReportClientEventRequest
- type ReportClientEventResponse
- type ReportResponse
- type RequestPermissionJSONRequestBody
- type RequestPermissionRequest
- type RequestPermissionRequestPermissions
- type RequestPermissionResponse
- type ResolutionMetricsTimeSeries
- type ResolveSIPAuthJSONRequestBody
- type ResolveSIPAuthRequest
- type ResolveSIPAuthResponse
- type ResolveSIPInboundJSONRequestBody
- type ResolveSIPInboundRequest
- type ResolveSIPInboundResponse
- type Response
- type RingCallJSONRequestBody
- type RingCallRequest
- type RingCallResponse
- type RingSettingsRequest
- type RingSettingsResponse
- type SDKUsageReport
- type SDKUsageReportResponse
- type SFULocationResponse
- type SFUResponse
- type SIPCallConfigsResponse
- type SIPCallerConfigsResponse
- type SIPChallengeRequest
- type SIPDirectRoutingRuleCallConfigsResponse
- type SIPInboundCredentials
- type SIPInboundRoutingRulePinConfigsResponse
- type SIPInboundRoutingRuleResponse
- type SIPPinProtectionConfigsResponse
- type SIPTrunkResponse
- type SRTIngress
- type ScoreBands
- type ScreensharingSettingsRequest
- type ScreensharingSettingsResponse
- type Segments
- type SendCallEventJSONRequestBody
- type SendCallEventRequest
- type SendCallEventResponse
- type SendVideoReactionJSONRequestBody
- type SendVideoReactionRequest
- type SendVideoReactionResponse
- type SessionClient
- type SessionSettingsRequest
- type SessionSettingsResponse
- type SessionWarningResponse
- type SortParamRequest
- type SourceHealth
- type SourceInterruption
- type SpeechSegmentConfig
- type StartClosedCaptionsJSONRequestBody
- type StartClosedCaptionsRequest
- type StartClosedCaptionsRequestLanguage
- type StartClosedCaptionsResponse
- type StartFrameRecordingJSONRequestBody
- type StartFrameRecordingRequest
- type StartFrameRecordingResponse
- type StartHLSBroadcastingRequest
- type StartHLSBroadcastingResponse
- type StartRTMPBroadcastsJSONRequestBody
- type StartRTMPBroadcastsRequest
- type StartRTMPBroadcastsResponse
- type StartRecordingJSONRequestBody
- type StartRecordingParamsRecordingType
- type StartRecordingRequest
- type StartRecordingResponse
- type StartTranscriptionJSONRequestBody
- type StartTranscriptionRequest
- type StartTranscriptionRequestLanguage
- type StartTranscriptionResponse
- type StatsOptions
- type StopAllRTMPBroadcastsRequest
- type StopAllRTMPBroadcastsResponse
- type StopClosedCaptionsJSONRequestBody
- type StopClosedCaptionsRequest
- type StopClosedCaptionsResponse
- type StopFrameRecordingRequest
- type StopFrameRecordingResponse
- type StopHLSBroadcastingRequest
- type StopHLSBroadcastingResponse
- type StopLiveJSONRequestBody
- type StopLiveRequest
- type StopLiveResponse
- type StopRTMPBroadcastJSONRequestBody
- type StopRTMPBroadcastsRequest
- type StopRTMPBroadcastsResponse
- type StopRecordingJSONRequestBody
- type StopRecordingParamsRecordingType
- type StopRecordingRequest
- type StopRecordingResponse
- type StopTranscriptionJSONRequestBody
- type StopTranscriptionRequest
- type StopTranscriptionResponse
- type SubscriberStatsResponse
- type Supporting
- type TargetResolution
- type ThumbnailResponse
- type ThumbnailsSettingsRequest
- type ThumbnailsSettingsResponse
- type Time
- type TimeWindow
- type TrackStatsResponse
- type TranscriptionSettingsRequest
- type TranscriptionSettingsRequestClosedCaptionMode
- type TranscriptionSettingsRequestLanguage
- type TranscriptionSettingsRequestMode
- type TranscriptionSettingsResponse
- type TranscriptionSettingsResponseClosedCaptionMode
- type TranscriptionSettingsResponseLanguage
- type TranscriptionSettingsResponseMode
- type TranslationSettings
- type TranslationSettingsLanguages
- type UnblockUserJSONRequestBody
- type UnblockUserRequest
- type UnblockUserResponse
- type UnblockedUserEvent
- type UnpinRequest
- type UnpinResponse
- type UpdateCallJSONRequestBody
- type UpdateCallMembersJSONRequestBody
- type UpdateCallMembersRequest
- type UpdateCallMembersResponse
- type UpdateCallRequest
- type UpdateCallResponse
- type UpdateUserPermissionsJSONRequestBody
- type UpdateUserPermissionsRequest
- type UpdateUserPermissionsRequestGrantPermissions
- type UpdateUserPermissionsRequestRevokePermissions
- type UpdateUserPermissionsResponse
- type UpdatedCallPermissionsEvent
- type UserBannedEvent
- type UserDeactivatedEvent
- type UserDeletedEvent
- type UserFeedbackReport
- type UserFeedbackReportResponse
- type UserPresenceChangedEvent
- type UserRatingReportResponse
- type UserReactivatedEvent
- type UserRequest
- type UserResponse
- type UserResponseCommonFields
- type UserResponsePrivacyFields
- type UserUnbannedEvent
- type UserUpdatedEvent
- type VideoEvent
- func (t VideoEvent) AsAppUpdatedEvent() (AppUpdatedEvent, error)
- func (t VideoEvent) AsBlockedUserEvent() (BlockedUserEvent, error)
- func (t VideoEvent) AsCallAcceptedEvent() (CallAcceptedEvent, error)
- func (t VideoEvent) AsCallClosedCaptionsFailedEvent() (CallClosedCaptionsFailedEvent, error)
- func (t VideoEvent) AsCallClosedCaptionsStartedEvent() (CallClosedCaptionsStartedEvent, error)
- func (t VideoEvent) AsCallClosedCaptionsStoppedEvent() (CallClosedCaptionsStoppedEvent, error)
- func (t VideoEvent) AsCallCreatedEvent() (CallCreatedEvent, error)
- func (t VideoEvent) AsCallDTMFEvent() (CallDTMFEvent, error)
- func (t VideoEvent) AsCallDeletedEvent() (CallDeletedEvent, error)
- func (t VideoEvent) AsCallEndedEvent() (CallEndedEvent, error)
- func (t VideoEvent) AsCallFrameRecordingFailedEvent() (CallFrameRecordingFailedEvent, error)
- func (t VideoEvent) AsCallFrameRecordingFrameReadyEvent() (CallFrameRecordingFrameReadyEvent, error)
- func (t VideoEvent) AsCallFrameRecordingStartedEvent() (CallFrameRecordingStartedEvent, error)
- func (t VideoEvent) AsCallFrameRecordingStoppedEvent() (CallFrameRecordingStoppedEvent, error)
- func (t VideoEvent) AsCallHLSBroadcastingFailedEvent() (CallHLSBroadcastingFailedEvent, error)
- func (t VideoEvent) AsCallHLSBroadcastingStartedEvent() (CallHLSBroadcastingStartedEvent, error)
- func (t VideoEvent) AsCallHLSBroadcastingStoppedEvent() (CallHLSBroadcastingStoppedEvent, error)
- func (t VideoEvent) AsCallLiveStartedEvent() (CallLiveStartedEvent, error)
- func (t VideoEvent) AsCallMemberAddedEvent() (CallMemberAddedEvent, error)
- func (t VideoEvent) AsCallMemberRemovedEvent() (CallMemberRemovedEvent, error)
- func (t VideoEvent) AsCallMemberUpdatedEvent() (CallMemberUpdatedEvent, error)
- func (t VideoEvent) AsCallMemberUpdatedPermissionEvent() (CallMemberUpdatedPermissionEvent, error)
- func (t VideoEvent) AsCallMissedEvent() (CallMissedEvent, error)
- func (t VideoEvent) AsCallModerationBlurEvent() (CallModerationBlurEvent, error)
- func (t VideoEvent) AsCallModerationWarningEvent() (CallModerationWarningEvent, error)
- func (t VideoEvent) AsCallNotificationEvent() (CallNotificationEvent, error)
- func (t VideoEvent) AsCallReactionEvent() (CallReactionEvent, error)
- func (t VideoEvent) AsCallRecordingFailedEvent() (CallRecordingFailedEvent, error)
- func (t VideoEvent) AsCallRecordingReadyEvent() (CallRecordingReadyEvent, error)
- func (t VideoEvent) AsCallRecordingStartedEvent() (CallRecordingStartedEvent, error)
- func (t VideoEvent) AsCallRecordingStoppedEvent() (CallRecordingStoppedEvent, error)
- func (t VideoEvent) AsCallRejectedEvent() (CallRejectedEvent, error)
- func (t VideoEvent) AsCallRingEvent() (CallRingEvent, error)
- func (t VideoEvent) AsCallRtmpBroadcastFailedEvent() (CallRtmpBroadcastFailedEvent, error)
- func (t VideoEvent) AsCallRtmpBroadcastStartedEvent() (CallRtmpBroadcastStartedEvent, error)
- func (t VideoEvent) AsCallRtmpBroadcastStoppedEvent() (CallRtmpBroadcastStoppedEvent, error)
- func (t VideoEvent) AsCallSessionEndedEvent() (CallSessionEndedEvent, error)
- func (t VideoEvent) AsCallSessionParticipantCountsUpdatedEvent() (CallSessionParticipantCountsUpdatedEvent, error)
- func (t VideoEvent) AsCallSessionParticipantJoinedEvent() (CallSessionParticipantJoinedEvent, error)
- func (t VideoEvent) AsCallSessionParticipantLeftEvent() (CallSessionParticipantLeftEvent, error)
- func (t VideoEvent) AsCallSessionStartedEvent() (CallSessionStartedEvent, error)
- func (t VideoEvent) AsCallStatsReportReadyEvent() (CallStatsReportReadyEvent, error)
- func (t VideoEvent) AsCallTranscriptionFailedEvent() (CallTranscriptionFailedEvent, error)
- func (t VideoEvent) AsCallTranscriptionReadyEvent() (CallTranscriptionReadyEvent, error)
- func (t VideoEvent) AsCallTranscriptionStartedEvent() (CallTranscriptionStartedEvent, error)
- func (t VideoEvent) AsCallTranscriptionStoppedEvent() (CallTranscriptionStoppedEvent, error)
- func (t VideoEvent) AsCallUpdatedEvent() (CallUpdatedEvent, error)
- func (t VideoEvent) AsCallUserFeedbackSubmittedEvent() (CallUserFeedbackSubmittedEvent, error)
- func (t VideoEvent) AsCallUserMutedEvent() (CallUserMutedEvent, error)
- func (t VideoEvent) AsClosedCaptionEvent() (ClosedCaptionEvent, error)
- func (t VideoEvent) AsConnectedEvent() (ConnectedEvent, error)
- func (t VideoEvent) AsConnectionErrorEvent() (ConnectionErrorEvent, error)
- func (t VideoEvent) AsCustomVideoEvent() (CustomVideoEvent, error)
- func (t VideoEvent) AsHealthCheckEvent() (HealthCheckEvent, error)
- func (t VideoEvent) AsIngressErrorEvent() (IngressErrorEvent, error)
- func (t VideoEvent) AsIngressStartedEvent() (IngressStartedEvent, error)
- func (t VideoEvent) AsIngressStoppedEvent() (IngressStoppedEvent, error)
- func (t VideoEvent) AsKickedUserEvent() (KickedUserEvent, error)
- func (t VideoEvent) AsPermissionRequestEvent() (PermissionRequestEvent, error)
- func (t VideoEvent) AsUnblockedUserEvent() (UnblockedUserEvent, error)
- func (t VideoEvent) AsUpdatedCallPermissionsEvent() (UpdatedCallPermissionsEvent, error)
- func (t VideoEvent) AsUserBannedEvent() (UserBannedEvent, error)
- func (t VideoEvent) AsUserDeactivatedEvent() (UserDeactivatedEvent, error)
- func (t VideoEvent) AsUserDeletedEvent() (UserDeletedEvent, error)
- func (t VideoEvent) AsUserPresenceChangedEvent() (UserPresenceChangedEvent, error)
- func (t VideoEvent) AsUserReactivatedEvent() (UserReactivatedEvent, error)
- func (t VideoEvent) AsUserUnbannedEvent() (UserUnbannedEvent, error)
- func (t VideoEvent) AsUserUpdatedEvent() (UserUpdatedEvent, error)
- func (t VideoEvent) Discriminator() (string, error)
- func (t *VideoEvent) FromAppUpdatedEvent(v AppUpdatedEvent) error
- func (t *VideoEvent) FromBlockedUserEvent(v BlockedUserEvent) error
- func (t *VideoEvent) FromCallAcceptedEvent(v CallAcceptedEvent) error
- func (t *VideoEvent) FromCallClosedCaptionsFailedEvent(v CallClosedCaptionsFailedEvent) error
- func (t *VideoEvent) FromCallClosedCaptionsStartedEvent(v CallClosedCaptionsStartedEvent) error
- func (t *VideoEvent) FromCallClosedCaptionsStoppedEvent(v CallClosedCaptionsStoppedEvent) error
- func (t *VideoEvent) FromCallCreatedEvent(v CallCreatedEvent) error
- func (t *VideoEvent) FromCallDTMFEvent(v CallDTMFEvent) error
- func (t *VideoEvent) FromCallDeletedEvent(v CallDeletedEvent) error
- func (t *VideoEvent) FromCallEndedEvent(v CallEndedEvent) error
- func (t *VideoEvent) FromCallFrameRecordingFailedEvent(v CallFrameRecordingFailedEvent) error
- func (t *VideoEvent) FromCallFrameRecordingFrameReadyEvent(v CallFrameRecordingFrameReadyEvent) error
- func (t *VideoEvent) FromCallFrameRecordingStartedEvent(v CallFrameRecordingStartedEvent) error
- func (t *VideoEvent) FromCallFrameRecordingStoppedEvent(v CallFrameRecordingStoppedEvent) error
- func (t *VideoEvent) FromCallHLSBroadcastingFailedEvent(v CallHLSBroadcastingFailedEvent) error
- func (t *VideoEvent) FromCallHLSBroadcastingStartedEvent(v CallHLSBroadcastingStartedEvent) error
- func (t *VideoEvent) FromCallHLSBroadcastingStoppedEvent(v CallHLSBroadcastingStoppedEvent) error
- func (t *VideoEvent) FromCallLiveStartedEvent(v CallLiveStartedEvent) error
- func (t *VideoEvent) FromCallMemberAddedEvent(v CallMemberAddedEvent) error
- func (t *VideoEvent) FromCallMemberRemovedEvent(v CallMemberRemovedEvent) error
- func (t *VideoEvent) FromCallMemberUpdatedEvent(v CallMemberUpdatedEvent) error
- func (t *VideoEvent) FromCallMemberUpdatedPermissionEvent(v CallMemberUpdatedPermissionEvent) error
- func (t *VideoEvent) FromCallMissedEvent(v CallMissedEvent) error
- func (t *VideoEvent) FromCallModerationBlurEvent(v CallModerationBlurEvent) error
- func (t *VideoEvent) FromCallModerationWarningEvent(v CallModerationWarningEvent) error
- func (t *VideoEvent) FromCallNotificationEvent(v CallNotificationEvent) error
- func (t *VideoEvent) FromCallReactionEvent(v CallReactionEvent) error
- func (t *VideoEvent) FromCallRecordingFailedEvent(v CallRecordingFailedEvent) error
- func (t *VideoEvent) FromCallRecordingReadyEvent(v CallRecordingReadyEvent) error
- func (t *VideoEvent) FromCallRecordingStartedEvent(v CallRecordingStartedEvent) error
- func (t *VideoEvent) FromCallRecordingStoppedEvent(v CallRecordingStoppedEvent) error
- func (t *VideoEvent) FromCallRejectedEvent(v CallRejectedEvent) error
- func (t *VideoEvent) FromCallRingEvent(v CallRingEvent) error
- func (t *VideoEvent) FromCallRtmpBroadcastFailedEvent(v CallRtmpBroadcastFailedEvent) error
- func (t *VideoEvent) FromCallRtmpBroadcastStartedEvent(v CallRtmpBroadcastStartedEvent) error
- func (t *VideoEvent) FromCallRtmpBroadcastStoppedEvent(v CallRtmpBroadcastStoppedEvent) error
- func (t *VideoEvent) FromCallSessionEndedEvent(v CallSessionEndedEvent) error
- func (t *VideoEvent) FromCallSessionParticipantCountsUpdatedEvent(v CallSessionParticipantCountsUpdatedEvent) error
- func (t *VideoEvent) FromCallSessionParticipantJoinedEvent(v CallSessionParticipantJoinedEvent) error
- func (t *VideoEvent) FromCallSessionParticipantLeftEvent(v CallSessionParticipantLeftEvent) error
- func (t *VideoEvent) FromCallSessionStartedEvent(v CallSessionStartedEvent) error
- func (t *VideoEvent) FromCallStatsReportReadyEvent(v CallStatsReportReadyEvent) error
- func (t *VideoEvent) FromCallTranscriptionFailedEvent(v CallTranscriptionFailedEvent) error
- func (t *VideoEvent) FromCallTranscriptionReadyEvent(v CallTranscriptionReadyEvent) error
- func (t *VideoEvent) FromCallTranscriptionStartedEvent(v CallTranscriptionStartedEvent) error
- func (t *VideoEvent) FromCallTranscriptionStoppedEvent(v CallTranscriptionStoppedEvent) error
- func (t *VideoEvent) FromCallUpdatedEvent(v CallUpdatedEvent) error
- func (t *VideoEvent) FromCallUserFeedbackSubmittedEvent(v CallUserFeedbackSubmittedEvent) error
- func (t *VideoEvent) FromCallUserMutedEvent(v CallUserMutedEvent) error
- func (t *VideoEvent) FromClosedCaptionEvent(v ClosedCaptionEvent) error
- func (t *VideoEvent) FromConnectedEvent(v ConnectedEvent) error
- func (t *VideoEvent) FromConnectionErrorEvent(v ConnectionErrorEvent) error
- func (t *VideoEvent) FromCustomVideoEvent(v CustomVideoEvent) error
- func (t *VideoEvent) FromHealthCheckEvent(v HealthCheckEvent) error
- func (t *VideoEvent) FromIngressErrorEvent(v IngressErrorEvent) error
- func (t *VideoEvent) FromIngressStartedEvent(v IngressStartedEvent) error
- func (t *VideoEvent) FromIngressStoppedEvent(v IngressStoppedEvent) error
- func (t *VideoEvent) FromKickedUserEvent(v KickedUserEvent) error
- func (t *VideoEvent) FromPermissionRequestEvent(v PermissionRequestEvent) error
- func (t *VideoEvent) FromUnblockedUserEvent(v UnblockedUserEvent) error
- func (t *VideoEvent) FromUpdatedCallPermissionsEvent(v UpdatedCallPermissionsEvent) error
- func (t *VideoEvent) FromUserBannedEvent(v UserBannedEvent) error
- func (t *VideoEvent) FromUserDeactivatedEvent(v UserDeactivatedEvent) error
- func (t *VideoEvent) FromUserDeletedEvent(v UserDeletedEvent) error
- func (t *VideoEvent) FromUserPresenceChangedEvent(v UserPresenceChangedEvent) error
- func (t *VideoEvent) FromUserReactivatedEvent(v UserReactivatedEvent) error
- func (t *VideoEvent) FromUserUnbannedEvent(v UserUnbannedEvent) error
- func (t *VideoEvent) FromUserUpdatedEvent(v UserUpdatedEvent) error
- func (t VideoEvent) MarshalJSON() ([]byte, error)
- func (t *VideoEvent) MergeAppUpdatedEvent(v AppUpdatedEvent) error
- func (t *VideoEvent) MergeBlockedUserEvent(v BlockedUserEvent) error
- func (t *VideoEvent) MergeCallAcceptedEvent(v CallAcceptedEvent) error
- func (t *VideoEvent) MergeCallClosedCaptionsFailedEvent(v CallClosedCaptionsFailedEvent) error
- func (t *VideoEvent) MergeCallClosedCaptionsStartedEvent(v CallClosedCaptionsStartedEvent) error
- func (t *VideoEvent) MergeCallClosedCaptionsStoppedEvent(v CallClosedCaptionsStoppedEvent) error
- func (t *VideoEvent) MergeCallCreatedEvent(v CallCreatedEvent) error
- func (t *VideoEvent) MergeCallDTMFEvent(v CallDTMFEvent) error
- func (t *VideoEvent) MergeCallDeletedEvent(v CallDeletedEvent) error
- func (t *VideoEvent) MergeCallEndedEvent(v CallEndedEvent) error
- func (t *VideoEvent) MergeCallFrameRecordingFailedEvent(v CallFrameRecordingFailedEvent) error
- func (t *VideoEvent) MergeCallFrameRecordingFrameReadyEvent(v CallFrameRecordingFrameReadyEvent) error
- func (t *VideoEvent) MergeCallFrameRecordingStartedEvent(v CallFrameRecordingStartedEvent) error
- func (t *VideoEvent) MergeCallFrameRecordingStoppedEvent(v CallFrameRecordingStoppedEvent) error
- func (t *VideoEvent) MergeCallHLSBroadcastingFailedEvent(v CallHLSBroadcastingFailedEvent) error
- func (t *VideoEvent) MergeCallHLSBroadcastingStartedEvent(v CallHLSBroadcastingStartedEvent) error
- func (t *VideoEvent) MergeCallHLSBroadcastingStoppedEvent(v CallHLSBroadcastingStoppedEvent) error
- func (t *VideoEvent) MergeCallLiveStartedEvent(v CallLiveStartedEvent) error
- func (t *VideoEvent) MergeCallMemberAddedEvent(v CallMemberAddedEvent) error
- func (t *VideoEvent) MergeCallMemberRemovedEvent(v CallMemberRemovedEvent) error
- func (t *VideoEvent) MergeCallMemberUpdatedEvent(v CallMemberUpdatedEvent) error
- func (t *VideoEvent) MergeCallMemberUpdatedPermissionEvent(v CallMemberUpdatedPermissionEvent) error
- func (t *VideoEvent) MergeCallMissedEvent(v CallMissedEvent) error
- func (t *VideoEvent) MergeCallModerationBlurEvent(v CallModerationBlurEvent) error
- func (t *VideoEvent) MergeCallModerationWarningEvent(v CallModerationWarningEvent) error
- func (t *VideoEvent) MergeCallNotificationEvent(v CallNotificationEvent) error
- func (t *VideoEvent) MergeCallReactionEvent(v CallReactionEvent) error
- func (t *VideoEvent) MergeCallRecordingFailedEvent(v CallRecordingFailedEvent) error
- func (t *VideoEvent) MergeCallRecordingReadyEvent(v CallRecordingReadyEvent) error
- func (t *VideoEvent) MergeCallRecordingStartedEvent(v CallRecordingStartedEvent) error
- func (t *VideoEvent) MergeCallRecordingStoppedEvent(v CallRecordingStoppedEvent) error
- func (t *VideoEvent) MergeCallRejectedEvent(v CallRejectedEvent) error
- func (t *VideoEvent) MergeCallRingEvent(v CallRingEvent) error
- func (t *VideoEvent) MergeCallRtmpBroadcastFailedEvent(v CallRtmpBroadcastFailedEvent) error
- func (t *VideoEvent) MergeCallRtmpBroadcastStartedEvent(v CallRtmpBroadcastStartedEvent) error
- func (t *VideoEvent) MergeCallRtmpBroadcastStoppedEvent(v CallRtmpBroadcastStoppedEvent) error
- func (t *VideoEvent) MergeCallSessionEndedEvent(v CallSessionEndedEvent) error
- func (t *VideoEvent) MergeCallSessionParticipantCountsUpdatedEvent(v CallSessionParticipantCountsUpdatedEvent) error
- func (t *VideoEvent) MergeCallSessionParticipantJoinedEvent(v CallSessionParticipantJoinedEvent) error
- func (t *VideoEvent) MergeCallSessionParticipantLeftEvent(v CallSessionParticipantLeftEvent) error
- func (t *VideoEvent) MergeCallSessionStartedEvent(v CallSessionStartedEvent) error
- func (t *VideoEvent) MergeCallStatsReportReadyEvent(v CallStatsReportReadyEvent) error
- func (t *VideoEvent) MergeCallTranscriptionFailedEvent(v CallTranscriptionFailedEvent) error
- func (t *VideoEvent) MergeCallTranscriptionReadyEvent(v CallTranscriptionReadyEvent) error
- func (t *VideoEvent) MergeCallTranscriptionStartedEvent(v CallTranscriptionStartedEvent) error
- func (t *VideoEvent) MergeCallTranscriptionStoppedEvent(v CallTranscriptionStoppedEvent) error
- func (t *VideoEvent) MergeCallUpdatedEvent(v CallUpdatedEvent) error
- func (t *VideoEvent) MergeCallUserFeedbackSubmittedEvent(v CallUserFeedbackSubmittedEvent) error
- func (t *VideoEvent) MergeCallUserMutedEvent(v CallUserMutedEvent) error
- func (t *VideoEvent) MergeClosedCaptionEvent(v ClosedCaptionEvent) error
- func (t *VideoEvent) MergeConnectedEvent(v ConnectedEvent) error
- func (t *VideoEvent) MergeConnectionErrorEvent(v ConnectionErrorEvent) error
- func (t *VideoEvent) MergeCustomVideoEvent(v CustomVideoEvent) error
- func (t *VideoEvent) MergeHealthCheckEvent(v HealthCheckEvent) error
- func (t *VideoEvent) MergeIngressErrorEvent(v IngressErrorEvent) error
- func (t *VideoEvent) MergeIngressStartedEvent(v IngressStartedEvent) error
- func (t *VideoEvent) MergeIngressStoppedEvent(v IngressStoppedEvent) error
- func (t *VideoEvent) MergeKickedUserEvent(v KickedUserEvent) error
- func (t *VideoEvent) MergePermissionRequestEvent(v PermissionRequestEvent) error
- func (t *VideoEvent) MergeUnblockedUserEvent(v UnblockedUserEvent) error
- func (t *VideoEvent) MergeUpdatedCallPermissionsEvent(v UpdatedCallPermissionsEvent) error
- func (t *VideoEvent) MergeUserBannedEvent(v UserBannedEvent) error
- func (t *VideoEvent) MergeUserDeactivatedEvent(v UserDeactivatedEvent) error
- func (t *VideoEvent) MergeUserDeletedEvent(v UserDeletedEvent) error
- func (t *VideoEvent) MergeUserPresenceChangedEvent(v UserPresenceChangedEvent) error
- func (t *VideoEvent) MergeUserReactivatedEvent(v UserReactivatedEvent) error
- func (t *VideoEvent) MergeUserUnbannedEvent(v UserUnbannedEvent) error
- func (t *VideoEvent) MergeUserUpdatedEvent(v UserUpdatedEvent) error
- func (t *VideoEvent) UnmarshalJSON(b []byte) error
- func (t VideoEvent) ValueByDiscriminator() (interface{}, error)
- type VideoPinJSONRequestBody
- type VideoReactionOverTimeResponse
- type VideoReactionResponse
- type VideoReactionsResponse
- type VideoSettingsRequest
- type VideoSettingsRequestCameraFacing
- type VideoSettingsResponse
- type VideoSettingsResponseCameraFacing
- type VideoUnpinJSONRequestBody
- type ViewerBehavior
- type WHIPIngress
- type WSAuthMessage
- type WSAuthMessageProducts
- type WSCallEvent
- func (t WSCallEvent) AsCallDTMFEvent() (CallDTMFEvent, error)
- func (t WSCallEvent) AsIngressErrorEvent() (IngressErrorEvent, error)
- func (t WSCallEvent) AsIngressStartedEvent() (IngressStartedEvent, error)
- func (t WSCallEvent) AsIngressStoppedEvent() (IngressStoppedEvent, error)
- func (t WSCallEvent) Discriminator() (string, error)
- func (t *WSCallEvent) FromCallDTMFEvent(v CallDTMFEvent) error
- func (t *WSCallEvent) FromIngressErrorEvent(v IngressErrorEvent) error
- func (t *WSCallEvent) FromIngressStartedEvent(v IngressStartedEvent) error
- func (t *WSCallEvent) FromIngressStoppedEvent(v IngressStoppedEvent) error
- func (t WSCallEvent) MarshalJSON() ([]byte, error)
- func (t *WSCallEvent) MergeCallDTMFEvent(v CallDTMFEvent) error
- func (t *WSCallEvent) MergeIngressErrorEvent(v IngressErrorEvent) error
- func (t *WSCallEvent) MergeIngressStartedEvent(v IngressStartedEvent) error
- func (t *WSCallEvent) MergeIngressStoppedEvent(v IngressStoppedEvent) error
- func (t *WSCallEvent) UnmarshalJSON(b []byte) error
- func (t WSCallEvent) ValueByDiscriminator() (interface{}, error)
- type WebsocketEvent
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetEventType ¶
GetEventType reads the discriminator out of a raw event payload without decoding the rest of it.
Types ¶
type APIError ¶
type APIError struct {
// StatusCode Response HTTP status code
StatusCode int32 `json:"StatusCode"`
// Code API error code
Code int32 `json:"code"`
// Details Additional error-specific information
Details []int `json:"details"`
// Duration Request duration
Duration string `json:"duration"`
// ExceptionFields Additional error info
ExceptionFields *map[string]string `json:"exception_fields,omitempty"`
// Message Message describing an error
Message string `json:"message"`
// MoreInfo URL with additional information
MoreInfo string `json:"more_info"`
// Unrecoverable Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it
Unrecoverable *bool `json:"unrecoverable,omitempty"`
}
APIError defines model for APIError.
type AbsentMetric ¶
AbsentMetric defines model for AbsentMetric.
type AcceptCallRequest ¶
type AcceptCallRequest = map[string]interface{}
AcceptCallRequest AcceptCallRequest is the payload for accepting a call.
type AcceptCallResponse ¶
type AcceptCallResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
AcceptCallResponse AcceptCallResponse is the payload for accepting a call.
type AppEventResponse ¶
type AppEventResponse struct {
// AsyncURLEnrichEnabled boolean
AsyncURLEnrichEnabled *bool `json:"async_url_enrich_enabled,omitempty"`
// AutoTranslationEnabled boolean
AutoTranslationEnabled bool `json:"auto_translation_enabled"`
FileUploadConfig *FileUploadConfig `json:"file_upload_config,omitempty"`
ImageUploadConfig *FileUploadConfig `json:"image_upload_config,omitempty"`
// Name string
Name string `json:"name"`
}
AppEventResponse defines model for AppEventResponse.
type AppUpdatedEvent ¶
type AppUpdatedEvent struct {
App AppEventResponse `json:"app"`
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
Custom map[string]interface{} `json:"custom"`
ReceivedAt *Time `json:"received_at,omitempty"`
// Type The type of event: "app.updated" in this case
Type string `json:"type"`
}
AppUpdatedEvent Emitted when app settings are updated
func (AppUpdatedEvent) GetEventType ¶
func (AppUpdatedEvent) GetEventType() string
type Audience ¶
type Audience struct {
AvgConcurrentViewers int64 `json:"avg_concurrent_viewers"`
ConcurrencyByMinute []ConcurrencyMinute `json:"concurrency_by_minute"`
HoursWatched float64 `json:"hours_watched"`
PeakAt *string `json:"peak_at,omitempty"`
PeakConcurrentViewers int32 `json:"peak_concurrent_viewers"`
RampUpMinTo90PctPeak *int64 `json:"ramp_up_min_to_90pct_peak,omitempty"`
RetentionAt90PctMark *float64 `json:"retention_at_90pct_mark,omitempty"`
RetentionAtMidpoint *float64 `json:"retention_at_midpoint,omitempty"`
Shape *string `json:"shape,omitempty"`
UniqueViewers int32 `json:"unique_viewers"`
ViewerConnections int32 `json:"viewer_connections"`
}
Audience defines model for Audience.
type AudioSettingsRequest ¶
type AudioSettingsRequest struct {
AccessRequestEnabled *bool `json:"access_request_enabled,omitempty"`
DefaultDevice AudioSettingsRequestDefaultDevice `json:"default_device"`
HifiAudioEnabled *bool `json:"hifi_audio_enabled,omitempty"`
MicDefaultOn *bool `json:"mic_default_on,omitempty"`
NoiseCancellation *NoiseCancellationSettings `json:"noise_cancellation,omitempty"`
OpusDtxEnabled *bool `json:"opus_dtx_enabled,omitempty"`
RedundantCodingEnabled *bool `json:"redundant_coding_enabled,omitempty"`
SpeakerDefaultOn *bool `json:"speaker_default_on,omitempty"`
}
AudioSettingsRequest defines model for AudioSettingsRequest.
type AudioSettingsRequestDefaultDevice ¶
type AudioSettingsRequestDefaultDevice string
AudioSettingsRequestDefaultDevice defines model for AudioSettingsRequest.DefaultDevice.
const ( AudioSettingsRequestDefaultDeviceEarpiece AudioSettingsRequestDefaultDevice = "earpiece" AudioSettingsRequestDefaultDeviceSpeaker AudioSettingsRequestDefaultDevice = "speaker" )
Defines values for AudioSettingsRequestDefaultDevice.
func (AudioSettingsRequestDefaultDevice) Valid ¶
func (e AudioSettingsRequestDefaultDevice) Valid() bool
Valid indicates whether the value is a known member of the AudioSettingsRequestDefaultDevice enum.
type AudioSettingsResponse ¶
type AudioSettingsResponse struct {
AccessRequestEnabled bool `json:"access_request_enabled"`
DefaultDevice AudioSettingsResponseDefaultDevice `json:"default_device"`
HifiAudioEnabled bool `json:"hifi_audio_enabled"`
MicDefaultOn bool `json:"mic_default_on"`
NoiseCancellation *NoiseCancellationSettings `json:"noise_cancellation,omitempty"`
OpusDtxEnabled bool `json:"opus_dtx_enabled"`
RedundantCodingEnabled bool `json:"redundant_coding_enabled"`
SpeakerDefaultOn bool `json:"speaker_default_on"`
}
AudioSettingsResponse defines model for AudioSettingsResponse.
type AudioSettingsResponseDefaultDevice ¶
type AudioSettingsResponseDefaultDevice string
AudioSettingsResponseDefaultDevice defines model for AudioSettingsResponse.DefaultDevice.
const ( AudioSettingsResponseDefaultDeviceEarpiece AudioSettingsResponseDefaultDevice = "earpiece" AudioSettingsResponseDefaultDeviceSpeaker AudioSettingsResponseDefaultDevice = "speaker" )
Defines values for AudioSettingsResponseDefaultDevice.
func (AudioSettingsResponseDefaultDevice) Valid ¶
func (e AudioSettingsResponseDefaultDevice) Valid() bool
Valid indicates whether the value is a known member of the AudioSettingsResponseDefaultDevice enum.
type BackstageSettingsRequest ¶
type BackstageSettingsRequest struct {
Enabled *bool `json:"enabled,omitempty"`
JoinAheadTimeSeconds *int32 `json:"join_ahead_time_seconds,omitempty"`
}
BackstageSettingsRequest defines model for BackstageSettingsRequest.
type BackstageSettingsResponse ¶
type BackstageSettingsResponse struct {
Enabled bool `json:"enabled"`
JoinAheadTimeSeconds *int32 `json:"join_ahead_time_seconds,omitempty"`
}
BackstageSettingsResponse defines model for BackstageSettingsResponse.
type BlockUserJSONRequestBody ¶
type BlockUserJSONRequestBody = BlockUserRequest
BlockUserJSONRequestBody defines body for BlockUser for application/json ContentType.
type BlockUserRequest ¶
type BlockUserRequest struct {
// UserID the user to block
UserID string `json:"user_id"`
}
BlockUserRequest BlockUserRequest is the payload for blocking a user.
type BlockUserResponse ¶
type BlockUserResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
BlockUserResponse BlockUserResponse is the payload for blocking a user.
type BlockedUserEvent ¶
type BlockedUserEvent struct {
// BlockedByUser User response object
BlockedByUser *UserResponse `json:"blocked_by_user,omitempty"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.blocked_user" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
BlockedUserEvent This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. If the user is the current user, the client should leave the call screen as well
func (BlockedUserEvent) GetEventType ¶
func (BlockedUserEvent) GetEventType() string
type BroadcastDigest ¶
type BroadcastDigest struct {
Audience Audience `json:"audience"`
Broadcast BroadcastInfo `json:"broadcast"`
Coverage Coverage `json:"coverage"`
Joins Joins `json:"joins"`
PoorTail PoorTail `json:"poor_tail"`
Quality Quality `json:"quality"`
SchemaVersion string `json:"schema_version"`
Segments Segments `json:"segments"`
Source SourceHealth `json:"source"`
Viewers ViewerBehavior `json:"viewers"`
}
BroadcastDigest defines model for BroadcastDigest.
type BroadcastInfo ¶
type BroadcastInfo struct {
AppID int64 `json:"app_id"`
CallCid string `json:"call_cid"`
CallSessionID string `json:"call_session_id"`
CallType string `json:"call_type"`
Creators []string `json:"creators"`
DurationMin float64 `json:"duration_min"`
EndedAt string `json:"ended_at"`
SourceMode *string `json:"source_mode,omitempty"`
StartedAt string `json:"started_at"`
}
BroadcastInfo defines model for BroadcastInfo.
type BroadcastSegment ¶
type BroadcastSegment struct {
AvgQualityScore *float64 `json:"avg_quality_score,omitempty"`
Key string `json:"key"`
P5QualityScore *float64 `json:"p5_quality_score,omitempty"`
PoorPct *float64 `json:"poor_pct,omitempty"`
Sessions int32 `json:"sessions"`
}
BroadcastSegment defines model for BroadcastSegment.
type BroadcastSettingsRequest ¶
type BroadcastSettingsRequest struct {
Enabled *bool `json:"enabled,omitempty"`
Hls *HLSSettingsRequest `json:"hls,omitempty"`
Rtmp *RTMPSettingsRequest `json:"rtmp,omitempty"`
}
BroadcastSettingsRequest defines model for BroadcastSettingsRequest.
type BroadcastSettingsResponse ¶
type BroadcastSettingsResponse struct {
Enabled bool `json:"enabled"`
// Hls HLSSettings is the payload for HLS settings
Hls HLSSettingsResponse `json:"hls"`
// Rtmp RTMPSettingsResponse is the payload for RTMP settings
Rtmp RTMPSettingsResponse `json:"rtmp"`
}
BroadcastSettingsResponse BroadcastSettingsResponse is the payload for broadcasting settings
type CallAcceptedEvent ¶
type CallAcceptedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.accepted" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
CallAcceptedEvent This event is sent when a user accepts a notification to join a call.
func (CallAcceptedEvent) GetEventType ¶
func (CallAcceptedEvent) GetEventType() string
type CallClosedCaption ¶
type CallClosedCaption struct {
EndTime Time `json:"end_time"`
ID string `json:"id"`
Language string `json:"language"`
Service *string `json:"service,omitempty"`
SpeakerID string `json:"speaker_id"`
StartTime Time `json:"start_time"`
Text string `json:"text"`
Translated bool `json:"translated"`
// User User response object
User UserResponse `json:"user"`
}
CallClosedCaption CallClosedCaption represents a closed caption of a call.
type CallClosedCaptionsFailedEvent ¶
type CallClosedCaptionsFailedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.closed_captions_failed" in this case
Type string `json:"type"`
}
CallClosedCaptionsFailedEvent This event is sent when call closed captions has failed
func (CallClosedCaptionsFailedEvent) GetEventType ¶
func (CallClosedCaptionsFailedEvent) GetEventType() string
type CallClosedCaptionsStartedEvent ¶
type CallClosedCaptionsStartedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.closed_captions_started" in this case
Type string `json:"type"`
}
CallClosedCaptionsStartedEvent This event is sent when call closed caption has started
func (CallClosedCaptionsStartedEvent) GetEventType ¶
func (CallClosedCaptionsStartedEvent) GetEventType() string
type CallClosedCaptionsStoppedEvent ¶
type CallClosedCaptionsStoppedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.transcription_stopped" in this case
Type string `json:"type"`
}
CallClosedCaptionsStoppedEvent This event is sent when call closed captions has stopped
func (CallClosedCaptionsStoppedEvent) GetEventType ¶
func (CallClosedCaptionsStoppedEvent) GetEventType() string
type CallCreatedEvent ¶
type CallCreatedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Members the members added to this call
Members []MemberResponse `json:"members"`
// Type The type of event: "call.created" in this case
Type string `json:"type"`
}
CallCreatedEvent This event is sent when a call is created. Clients receiving this event should check if the ringing field is set to true and if so, show the call screen
func (CallCreatedEvent) GetEventType ¶
func (CallCreatedEvent) GetEventType() string
type CallDTMFEvent ¶
type CallDTMFEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Digit The DTMF digit (0-9, *, #, A-D)
Digit string `json:"digit"`
// DurationMs Duration of the digit press in milliseconds
DurationMs int `json:"duration_ms"`
// SeqNumber Monotonically increasing sequence number for ordering DTMF events within a session
SeqNumber int `json:"seq_number"`
// Timestamp When the digit press ended and was detected
Timestamp Time `json:"timestamp"`
// Type The type of event: "call.dtmf" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
CallDTMFEvent This event is sent asynchronously when a single DTMF digit is received from a SIP participant. The event is broadcast after the digit press ends. Use seq_number for ordering within a session and timestamp for the actual detection time.
func (CallDTMFEvent) GetEventType ¶
func (CallDTMFEvent) GetEventType() string
type CallDeletedEvent ¶
type CallDeletedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.deleted" in this case
Type string `json:"type"`
}
CallDeletedEvent This event is sent when a call is deleted. Clients receiving this event should leave the call screen
func (CallDeletedEvent) GetEventType ¶
func (CallDeletedEvent) GetEventType() string
type CallDurationReport ¶
type CallDurationReport struct {
Histogram []ReportByHistogramBucket `json:"histogram"`
}
CallDurationReport defines model for CallDurationReport.
type CallDurationReportResponse ¶
type CallDurationReportResponse struct {
Daily []DailyAggregateCallDurationReportResponse `json:"daily"`
}
CallDurationReportResponse defines model for CallDurationReportResponse.
type CallEndedEvent ¶
type CallEndedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Members The list of members in the call
Members *[]MemberResponse `json:"members,omitempty"`
// Reason The reason why the call ended, if available
Reason *string `json:"reason,omitempty"`
// Type The type of event: "call.ended" in this case
Type string `json:"type"`
// User User response object
User *UserResponse `json:"user,omitempty"`
}
CallEndedEvent This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen
func (CallEndedEvent) GetEventType ¶
func (CallEndedEvent) GetEventType() string
type CallFrameRecordingFailedEvent ¶
type CallFrameRecordingFailedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// Type The type of event: "call.frame_recording_failed" in this case
Type string `json:"type"`
}
CallFrameRecordingFailedEvent This event is sent when frame recording has failed
func (CallFrameRecordingFailedEvent) GetEventType ¶
func (CallFrameRecordingFailedEvent) GetEventType() string
type CallFrameRecordingFrameReadyEvent ¶
type CallFrameRecordingFrameReadyEvent struct {
CallCid string `json:"call_cid"`
// CapturedAt The time the frame was captured
CapturedAt Time `json:"captured_at"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// TrackType The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)
TrackType string `json:"track_type"`
// Type The type of event: "call.frame_recording_ready" in this case
Type string `json:"type"`
// URL The URL of the frame
URL string `json:"url"`
// Users The users in the frame
Users map[string]UserResponse `json:"users"`
}
CallFrameRecordingFrameReadyEvent This event is sent when a frame is captured from a call
func (CallFrameRecordingFrameReadyEvent) GetEventType ¶
func (CallFrameRecordingFrameReadyEvent) GetEventType() string
type CallFrameRecordingStartedEvent ¶
type CallFrameRecordingStartedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// Type The type of event: "call.frame_recording_started" in this case
Type string `json:"type"`
}
CallFrameRecordingStartedEvent This event is sent when frame recording has started
func (CallFrameRecordingStartedEvent) GetEventType ¶
func (CallFrameRecordingStartedEvent) GetEventType() string
type CallFrameRecordingStoppedEvent ¶
type CallFrameRecordingStoppedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// Type The type of event: "call.frame_recording_stopped" in this case
Type string `json:"type"`
}
CallFrameRecordingStoppedEvent This event is sent when frame recording has stopped
func (CallFrameRecordingStoppedEvent) GetEventType ¶
func (CallFrameRecordingStoppedEvent) GetEventType() string
type CallHLSBroadcastingFailedEvent ¶
type CallHLSBroadcastingFailedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.hls_broadcasting_failed" in this case
Type string `json:"type"`
}
CallHLSBroadcastingFailedEvent This event is sent when HLS broadcasting has failed
func (CallHLSBroadcastingFailedEvent) GetEventType ¶
func (CallHLSBroadcastingFailedEvent) GetEventType() string
type CallHLSBroadcastingStartedEvent ¶
type CallHLSBroadcastingStartedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
HlsPlaylistURL string `json:"hls_playlist_url"`
// Type The type of event: "call.hls_broadcasting_started" in this case
Type string `json:"type"`
}
CallHLSBroadcastingStartedEvent This event is sent when HLS broadcasting has started
func (CallHLSBroadcastingStartedEvent) GetEventType ¶
func (CallHLSBroadcastingStartedEvent) GetEventType() string
type CallHLSBroadcastingStoppedEvent ¶
type CallHLSBroadcastingStoppedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.hls_broadcasting_stopped" in this case
Type string `json:"type"`
}
CallHLSBroadcastingStoppedEvent This event is sent when HLS broadcasting has stopped
func (CallHLSBroadcastingStoppedEvent) GetEventType ¶
func (CallHLSBroadcastingStoppedEvent) GetEventType() string
type CallIngressResponse ¶
type CallIngressResponse struct {
// Rtmp RTMP input settings
Rtmp RTMPIngress `json:"rtmp"`
Srt SRTIngress `json:"srt"`
Whip WHIPIngress `json:"whip"`
}
CallIngressResponse CallIngressResponse is the payload for ingress settings
type CallLevelEventPayload ¶
type CallLevelEventPayload struct {
EventType string `json:"event_type"`
Payload *map[string]interface{} `json:"payload,omitempty"`
Timestamp int64 `json:"timestamp"`
UserID string `json:"user_id"`
}
CallLevelEventPayload defines model for CallLevelEventPayload.
type CallLiveStartedEvent ¶
type CallLiveStartedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.live_started" in this case
Type string `json:"type"`
}
CallLiveStartedEvent This event is sent when a call is started. Clients receiving this event should start the call.
func (CallLiveStartedEvent) GetEventType ¶
func (CallLiveStartedEvent) GetEventType() string
type CallMemberAddedEvent ¶
type CallMemberAddedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Members the members added to this call
Members []MemberResponse `json:"members"`
// Type The type of event: "call.member_added" in this case
Type string `json:"type"`
}
CallMemberAddedEvent This event is sent when one or more members are added to a call
func (CallMemberAddedEvent) GetEventType ¶
func (CallMemberAddedEvent) GetEventType() string
type CallMemberRemovedEvent ¶
type CallMemberRemovedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Members the list of member IDs removed from the call
Members []string `json:"members"`
// Type The type of event: "call.member_removed" in this case
Type string `json:"type"`
}
CallMemberRemovedEvent This event is sent when one or more members are removed from a call
func (CallMemberRemovedEvent) GetEventType ¶
func (CallMemberRemovedEvent) GetEventType() string
type CallMemberUpdatedEvent ¶
type CallMemberUpdatedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Members The list of members that were updated
Members []MemberResponse `json:"members"`
// Type The type of event: "call.member_updated" in this case
Type string `json:"type"`
}
CallMemberUpdatedEvent This event is sent when one or more members are updated
func (CallMemberUpdatedEvent) GetEventType ¶
func (CallMemberUpdatedEvent) GetEventType() string
type CallMemberUpdatedPermissionEvent ¶
type CallMemberUpdatedPermissionEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
// CapabilitiesByRole The capabilities by role for this call
CapabilitiesByRole map[string][]string `json:"capabilities_by_role"`
CreatedAt Time `json:"created_at"`
// Members The list of members that were updated
Members []MemberResponse `json:"members"`
// Type The type of event: "call.member_added" in this case
Type string `json:"type"`
}
CallMemberUpdatedPermissionEvent This event is sent when one or more members get its role updated
func (CallMemberUpdatedPermissionEvent) GetEventType ¶
func (CallMemberUpdatedPermissionEvent) GetEventType() string
type CallMissedEvent ¶
type CallMissedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Members List of members who missed the call
Members []MemberResponse `json:"members"`
NotifyUser bool `json:"notify_user"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// Type The type of event: "call.notification" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
CallMissedEvent This event is sent to call members who did not accept/reject/join the call to notify they missed the call
func (CallMissedEvent) GetEventType ¶
func (CallMissedEvent) GetEventType() string
type CallModerationBlurEvent ¶
type CallModerationBlurEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Custom Custom data associated with the moderation action
Custom map[string]interface{} `json:"custom"`
// Type The type of event: "call.moderation_blur" in this case
Type string `json:"type"`
// UserID The user ID whose video stream is being blurred
UserID string `json:"user_id"`
}
CallModerationBlurEvent This event is sent when a moderation blur action is applied to a user's video stream
func (CallModerationBlurEvent) GetEventType ¶
func (CallModerationBlurEvent) GetEventType() string
type CallModerationWarningEvent ¶
type CallModerationWarningEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Custom Custom data associated with the moderation action
Custom map[string]interface{} `json:"custom"`
// Message The warning message
Message string `json:"message"`
// Type The type of event: "call.moderation_warning" in this case
Type string `json:"type"`
// UserID The user ID who is receiving the warning
UserID string `json:"user_id"`
}
CallModerationWarningEvent This event is sent when a moderation warning is issued to a user
func (CallModerationWarningEvent) GetEventType ¶
func (CallModerationWarningEvent) GetEventType() string
type CallNotificationEvent ¶
type CallNotificationEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Members Call members
Members []MemberResponse `json:"members"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// Type The type of event: "call.notification" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
CallNotificationEvent This event is sent to all call members to notify they are getting called
func (CallNotificationEvent) GetEventType ¶
func (CallNotificationEvent) GetEventType() string
type CallParticipantCountReport ¶
type CallParticipantCountReport struct {
Histogram []ReportByHistogramBucket `json:"histogram"`
}
CallParticipantCountReport defines model for CallParticipantCountReport.
type CallParticipantCountReportResponse ¶
type CallParticipantCountReportResponse struct {
Daily []DailyAggregateCallParticipantCountReportResponse `json:"daily"`
}
CallParticipantCountReportResponse defines model for CallParticipantCountReportResponse.
type CallParticipantResponse ¶
type CallParticipantResponse struct {
JoinedAt Time `json:"joined_at"`
Role string `json:"role"`
// User User response object
User UserResponse `json:"user"`
UserSessionID string `json:"user_session_id"`
}
CallParticipantResponse defines model for CallParticipantResponse.
type CallParticipantTimeline ¶
type CallParticipantTimeline struct {
Data map[string]interface{} `json:"data"`
Severity string `json:"severity"`
Timestamp Time `json:"timestamp"`
Type string `json:"type"`
}
CallParticipantTimeline defines model for CallParticipantTimeline.
type CallReactionEvent ¶
type CallReactionEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
Reaction VideoReactionResponse `json:"reaction"`
// Type The type of event: "call.reaction_new" in this case
Type string `json:"type"`
}
CallReactionEvent This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen
func (CallReactionEvent) GetEventType ¶
func (CallReactionEvent) GetEventType() string
type CallRecording ¶
type CallRecording struct {
EndTime Time `json:"end_time"`
Filename string `json:"filename"`
RecordingType string `json:"recording_type"`
SessionID string `json:"session_id"`
StartTime Time `json:"start_time"`
URL string `json:"url"`
}
CallRecording CallRecording represents a recording of a call.
type CallRecordingFailedEvent ¶
type CallRecordingFailedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// RecordingType The type of recording
RecordingType CallRecordingFailedEventRecordingType `json:"recording_type"`
// Type The type of event: "call.recording_failed" in this case
Type string `json:"type"`
}
CallRecordingFailedEvent This event is sent when call recording has failed
func (CallRecordingFailedEvent) GetEventType ¶
func (CallRecordingFailedEvent) GetEventType() string
type CallRecordingFailedEventRecordingType ¶
type CallRecordingFailedEventRecordingType string
CallRecordingFailedEventRecordingType The type of recording
const ( CallRecordingFailedEventRecordingTypeComposite CallRecordingFailedEventRecordingType = "composite" CallRecordingFailedEventRecordingTypeIndividual CallRecordingFailedEventRecordingType = "individual" CallRecordingFailedEventRecordingTypeRaw CallRecordingFailedEventRecordingType = "raw" )
Defines values for CallRecordingFailedEventRecordingType.
func (CallRecordingFailedEventRecordingType) Valid ¶
func (e CallRecordingFailedEventRecordingType) Valid() bool
Valid indicates whether the value is a known member of the CallRecordingFailedEventRecordingType enum.
type CallRecordingReadyEvent ¶
type CallRecordingReadyEvent struct {
CallCid string `json:"call_cid"`
// CallRecording CallRecording represents a recording of a call.
CallRecording CallRecording `json:"call_recording"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// RecordingType The type of recording
RecordingType CallRecordingReadyEventRecordingType `json:"recording_type"`
// Type The type of event: "call.recording_ready" in this case
Type string `json:"type"`
}
CallRecordingReadyEvent This event is sent when call recording is ready
func (CallRecordingReadyEvent) GetEventType ¶
func (CallRecordingReadyEvent) GetEventType() string
type CallRecordingReadyEventRecordingType ¶
type CallRecordingReadyEventRecordingType string
CallRecordingReadyEventRecordingType The type of recording
const ( CallRecordingReadyEventRecordingTypeComposite CallRecordingReadyEventRecordingType = "composite" CallRecordingReadyEventRecordingTypeIndividual CallRecordingReadyEventRecordingType = "individual" CallRecordingReadyEventRecordingTypeRaw CallRecordingReadyEventRecordingType = "raw" )
Defines values for CallRecordingReadyEventRecordingType.
func (CallRecordingReadyEventRecordingType) Valid ¶
func (e CallRecordingReadyEventRecordingType) Valid() bool
Valid indicates whether the value is a known member of the CallRecordingReadyEventRecordingType enum.
type CallRecordingStartedEvent ¶
type CallRecordingStartedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// RecordingType The type of recording
RecordingType CallRecordingStartedEventRecordingType `json:"recording_type"`
// Type The type of event: "call.recording_started" in this case
Type string `json:"type"`
}
CallRecordingStartedEvent This event is sent when call recording has started
func (CallRecordingStartedEvent) GetEventType ¶
func (CallRecordingStartedEvent) GetEventType() string
type CallRecordingStartedEventRecordingType ¶
type CallRecordingStartedEventRecordingType string
CallRecordingStartedEventRecordingType The type of recording
const ( CallRecordingStartedEventRecordingTypeComposite CallRecordingStartedEventRecordingType = "composite" CallRecordingStartedEventRecordingTypeIndividual CallRecordingStartedEventRecordingType = "individual" CallRecordingStartedEventRecordingTypeRaw CallRecordingStartedEventRecordingType = "raw" )
Defines values for CallRecordingStartedEventRecordingType.
func (CallRecordingStartedEventRecordingType) Valid ¶
func (e CallRecordingStartedEventRecordingType) Valid() bool
Valid indicates whether the value is a known member of the CallRecordingStartedEventRecordingType enum.
type CallRecordingStoppedEvent ¶
type CallRecordingStoppedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// RecordingType The type of recording
RecordingType CallRecordingStoppedEventRecordingType `json:"recording_type"`
// Type The type of event: "call.recording_stopped" in this case
Type string `json:"type"`
}
CallRecordingStoppedEvent This event is sent when call recording has stopped
func (CallRecordingStoppedEvent) GetEventType ¶
func (CallRecordingStoppedEvent) GetEventType() string
type CallRecordingStoppedEventRecordingType ¶
type CallRecordingStoppedEventRecordingType string
CallRecordingStoppedEventRecordingType The type of recording
const ( CallRecordingStoppedEventRecordingTypeComposite CallRecordingStoppedEventRecordingType = "composite" CallRecordingStoppedEventRecordingTypeIndividual CallRecordingStoppedEventRecordingType = "individual" CallRecordingStoppedEventRecordingTypeRaw CallRecordingStoppedEventRecordingType = "raw" )
Defines values for CallRecordingStoppedEventRecordingType.
func (CallRecordingStoppedEventRecordingType) Valid ¶
func (e CallRecordingStoppedEventRecordingType) Valid() bool
Valid indicates whether the value is a known member of the CallRecordingStoppedEventRecordingType enum.
type CallRejectedEvent ¶
type CallRejectedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Reason Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy
Reason *string `json:"reason,omitempty"`
// Type The type of event: "call.rejected" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
CallRejectedEvent This event is sent when a user rejects a notification to join a call.
func (CallRejectedEvent) GetEventType ¶
func (CallRejectedEvent) GetEventType() string
type CallReportResponse ¶
type CallReportResponse struct {
EndedAt *Time `json:"ended_at,omitempty"`
Score float64 `json:"score"`
StartedAt *Time `json:"started_at,omitempty"`
}
CallReportResponse defines model for CallReportResponse.
type CallRequest ¶
type CallRequest struct {
ChannelCid *string `json:"channel_cid,omitempty"`
Custom *map[string]interface{} `json:"custom,omitempty"`
Members *[]MemberRequest `json:"members,omitempty"`
SettingsOverride *CallSettingsRequest `json:"settings_override,omitempty"`
StartsAt *Time `json:"starts_at,omitempty"`
Team *string `json:"team,omitempty"`
Video *bool `json:"video,omitempty"`
}
CallRequest CallRequest is the payload for creating a call.
type CallResponse ¶
type CallResponse struct {
Backstage bool `json:"backstage"`
BlockedUserIds []string `json:"blocked_user_ids"`
Captioning bool `json:"captioning"`
ChannelCid *string `json:"channel_cid,omitempty"`
// Cid The unique identifier for a call (<type>:<id>)
Cid string `json:"cid"`
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
// CreatedBy User response object
CreatedBy UserResponse `json:"created_by"`
CurrentSessionID string `json:"current_session_id"`
// Custom Custom data for this object
Custom map[string]interface{} `json:"custom"`
Egress EgressResponse `json:"egress"`
// EndedAt Date/time when the call ended
EndedAt *Time `json:"ended_at,omitempty"`
// ID Call ID
ID string `json:"id"`
// Ingress CallIngressResponse is the payload for ingress settings
Ingress CallIngressResponse `json:"ingress"`
JoinAheadTimeSeconds *int32 `json:"join_ahead_time_seconds,omitempty"`
Recording bool `json:"recording"`
// RoutingNumber 10-digit routing number for SIP routing
RoutingNumber *string `json:"routing_number,omitempty"`
Session *CallSessionResponse `json:"session,omitempty"`
Settings CallSettingsResponse `json:"settings"`
// StartsAt Date/time when the call will start
StartsAt *Time `json:"starts_at,omitempty"`
Team *string `json:"team,omitempty"`
Thumbnails *ThumbnailResponse `json:"thumbnails,omitempty"`
Transcribing bool `json:"transcribing"`
Translating bool `json:"translating"`
// Type The type of call
Type string `json:"type"`
// UpdatedAt Date/time of the last update
UpdatedAt Time `json:"updated_at"`
}
CallResponse Represents a call
type CallRingEvent ¶
type CallRingEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Members Call members
Members []MemberResponse `json:"members"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// Type The type of event: "call.notification" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
Video bool `json:"video"`
}
CallRingEvent This event is sent to all call members to notify they are getting called
func (CallRingEvent) GetEventType ¶
func (CallRingEvent) GetEventType() string
type CallRtmpBroadcastFailedEvent ¶
type CallRtmpBroadcastFailedEvent struct {
// CallCid The unique identifier for a call (<type>:<id>)
CallCid string `json:"call_cid"`
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
// Name Name of the given RTMP broadcast
Name string `json:"name"`
// Type The type of event: "call.rtmp_broadcast_failed" in this case
Type string `json:"type"`
}
CallRtmpBroadcastFailedEvent This event is sent when a call RTMP broadcast has failed
func (CallRtmpBroadcastFailedEvent) GetEventType ¶
func (CallRtmpBroadcastFailedEvent) GetEventType() string
type CallRtmpBroadcastStartedEvent ¶
type CallRtmpBroadcastStartedEvent struct {
// CallCid The unique identifier for a call (<type>:<id>)
CallCid string `json:"call_cid"`
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
// Name Name of the given RTMP broadcast
Name string `json:"name"`
// Type The type of event: "call.rtmp_broadcast_started" in this case
Type string `json:"type"`
}
CallRtmpBroadcastStartedEvent This event is sent when RTMP broadcast has started
func (CallRtmpBroadcastStartedEvent) GetEventType ¶
func (CallRtmpBroadcastStartedEvent) GetEventType() string
type CallRtmpBroadcastStoppedEvent ¶
type CallRtmpBroadcastStoppedEvent struct {
// CallCid The unique identifier for a call (<type>:<id>)
CallCid string `json:"call_cid"`
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
// Name Name of the given RTMP broadcast
Name string `json:"name"`
// Type The type of event: "call.rtmp_broadcast_stopped" in this case
Type string `json:"type"`
}
CallRtmpBroadcastStoppedEvent This event is sent when RTMP broadcast has stopped
func (CallRtmpBroadcastStoppedEvent) GetEventType ¶
func (CallRtmpBroadcastStoppedEvent) GetEventType() string
type CallSessionEndedEvent ¶
type CallSessionEndedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// Type The type of event: "call.session_ended" in this case
Type string `json:"type"`
}
CallSessionEndedEvent This event is sent when a call session ends
func (CallSessionEndedEvent) GetEventType ¶
func (CallSessionEndedEvent) GetEventType() string
type CallSessionParticipantCountsUpdatedEvent ¶
type CallSessionParticipantCountsUpdatedEvent struct {
AnonymousParticipantCount int32 `json:"anonymous_participant_count"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
ParticipantsCountByRole map[string]int32 `json:"participants_count_by_role"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// Type The type of event: "call.session_participant_count_updated" in this case
Type string `json:"type"`
}
CallSessionParticipantCountsUpdatedEvent This event is sent when the participant counts in a call session are updated
func (CallSessionParticipantCountsUpdatedEvent) GetEventType ¶
func (CallSessionParticipantCountsUpdatedEvent) GetEventType() string
type CallSessionParticipantJoinedEvent ¶
type CallSessionParticipantJoinedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
Participant CallParticipantResponse `json:"participant"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// Type The type of event: "call.session_participant_joined" in this case
Type string `json:"type"`
}
CallSessionParticipantJoinedEvent This event is sent when a participant joins a call session
func (CallSessionParticipantJoinedEvent) GetEventType ¶
func (CallSessionParticipantJoinedEvent) GetEventType() string
type CallSessionParticipantLeftEvent ¶
type CallSessionParticipantLeftEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// DurationSeconds The duration participant was in the session in seconds
DurationSeconds int32 `json:"duration_seconds"`
Participant CallParticipantResponse `json:"participant"`
// Reason The reason why the participant left the session
Reason *string `json:"reason,omitempty"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// Type The type of event: "call.session_participant_left" in this case
Type string `json:"type"`
}
CallSessionParticipantLeftEvent This event is sent when a participant leaves a call session
func (CallSessionParticipantLeftEvent) GetEventType ¶
func (CallSessionParticipantLeftEvent) GetEventType() string
type CallSessionResponse ¶
type CallSessionResponse struct {
AcceptedBy map[string]Time `json:"accepted_by"`
AnonymousParticipantCount int32 `json:"anonymous_participant_count"`
EndedAt *Time `json:"ended_at,omitempty"`
ID string `json:"id"`
LiveEndedAt *Time `json:"live_ended_at,omitempty"`
LiveStartedAt *Time `json:"live_started_at,omitempty"`
MissedBy map[string]Time `json:"missed_by"`
Participants []CallParticipantResponse `json:"participants"`
ParticipantsCountByRole map[string]int32 `json:"participants_count_by_role"`
RejectedBy map[string]Time `json:"rejected_by"`
StartedAt *Time `json:"started_at,omitempty"`
TimerEndsAt *Time `json:"timer_ends_at,omitempty"`
}
CallSessionResponse defines model for CallSessionResponse.
type CallSessionStartedEvent ¶
type CallSessionStartedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// Type The type of event: "call.session_started" in this case
Type string `json:"type"`
}
CallSessionStartedEvent This event is sent when a call session starts
func (CallSessionStartedEvent) GetEventType ¶
func (CallSessionStartedEvent) GetEventType() string
type CallSettingsRequest ¶
type CallSettingsRequest struct {
Audio *AudioSettingsRequest `json:"audio,omitempty"`
Backstage *BackstageSettingsRequest `json:"backstage,omitempty"`
Broadcasting *BroadcastSettingsRequest `json:"broadcasting,omitempty"`
Encryption *EncryptionSettingsRequest `json:"encryption,omitempty"`
FrameRecording *FrameRecordingSettingsRequest `json:"frame_recording,omitempty"`
Geofencing *GeofenceSettingsRequest `json:"geofencing,omitempty"`
IndividualRecording *IndividualRecordingSettingsRequest `json:"individual_recording,omitempty"`
Ingress *IngressSettingsRequest `json:"ingress,omitempty"`
Limits *LimitsSettingsRequest `json:"limits,omitempty"`
RawRecording *RawRecordingSettingsRequest `json:"raw_recording,omitempty"`
Recording *RecordSettingsRequest `json:"recording,omitempty"`
Ring *RingSettingsRequest `json:"ring,omitempty"`
Screensharing *ScreensharingSettingsRequest `json:"screensharing,omitempty"`
Session *SessionSettingsRequest `json:"session,omitempty"`
Thumbnails *ThumbnailsSettingsRequest `json:"thumbnails,omitempty"`
Transcription *TranscriptionSettingsRequest `json:"transcription,omitempty"`
Video *VideoSettingsRequest `json:"video,omitempty"`
}
CallSettingsRequest defines model for CallSettingsRequest.
type CallSettingsResponse ¶
type CallSettingsResponse struct {
Audio AudioSettingsResponse `json:"audio"`
Backstage BackstageSettingsResponse `json:"backstage"`
// Broadcasting BroadcastSettingsResponse is the payload for broadcasting settings
Broadcasting BroadcastSettingsResponse `json:"broadcasting"`
// Encryption EncryptionSettings is the payload for end-to-end encryption settings
Encryption EncryptionSettingsResponse `json:"encryption"`
FrameRecording FrameRecordingSettingsResponse `json:"frame_recording"`
Geofencing GeofenceSettingsResponse `json:"geofencing"`
IndividualRecording IndividualRecordingSettingsResponse `json:"individual_recording"`
Ingress *IngressSettingsResponse `json:"ingress,omitempty"`
Limits LimitsSettingsResponse `json:"limits"`
RawRecording RawRecordingSettingsResponse `json:"raw_recording"`
// Recording RecordSettings is the payload for recording settings
Recording RecordSettingsResponse `json:"recording"`
Ring RingSettingsResponse `json:"ring"`
Screensharing ScreensharingSettingsResponse `json:"screensharing"`
Session SessionSettingsResponse `json:"session"`
Thumbnails ThumbnailsSettingsResponse `json:"thumbnails"`
Transcription TranscriptionSettingsResponse `json:"transcription"`
Video VideoSettingsResponse `json:"video"`
}
CallSettingsResponse defines model for CallSettingsResponse.
type CallStateResponseFields ¶
type CallStateResponseFields struct {
// Call Represents a call
Call CallResponse `json:"call"`
// Members List of call members
Members []MemberResponse `json:"members"`
// Membership MemberResponse is the payload for a member of a call.
Membership *MemberResponse `json:"membership,omitempty"`
OwnCapabilities []OwnCapability `json:"own_capabilities"`
}
CallStateResponseFields CallStateResponseFields is the payload for call state response
type CallStatsLocation ¶
type CallStatsLocation struct {
AccuracyRadiusMeters *int32 `json:"accuracy_radius_meters,omitempty"`
City *string `json:"city,omitempty"`
Continent *string `json:"continent,omitempty"`
Country *string `json:"country,omitempty"`
CountryIsoCode *string `json:"country_iso_code,omitempty"`
Latitude *float64 `json:"latitude,omitempty"`
Longitude *float64 `json:"longitude,omitempty"`
Subdivision *string `json:"subdivision,omitempty"`
}
CallStatsLocation defines model for CallStatsLocation.
type CallStatsMapLocation ¶
type CallStatsMapLocation struct {
Count int32 `json:"count"`
LiveCount int32 `json:"live_count"`
Location *CallStatsLocation `json:"location,omitempty"`
}
CallStatsMapLocation defines model for CallStatsMapLocation.
type CallStatsMapPublisher ¶
type CallStatsMapPublisher struct {
IsLive bool `json:"is_live"`
Location *CallStatsLocation `json:"location,omitempty"`
Name *string `json:"name,omitempty"`
PublishedTracks PublishedTrackFlags `json:"published_tracks"`
PublisherType *string `json:"publisher_type,omitempty"`
UserID string `json:"user_id"`
UserSessionID string `json:"user_session_id"`
}
CallStatsMapPublisher defines model for CallStatsMapPublisher.
type CallStatsMapPublishers ¶
type CallStatsMapPublishers struct {
Publishers []CallStatsMapPublisher `json:"publishers"`
}
CallStatsMapPublishers defines model for CallStatsMapPublishers.
type CallStatsMapSFUs ¶
type CallStatsMapSFUs struct {
Locations []SFULocationResponse `json:"locations"`
}
CallStatsMapSFUs defines model for CallStatsMapSFUs.
type CallStatsMapSubscriber ¶
type CallStatsMapSubscriber struct {
IsLive bool `json:"is_live"`
Location *CallStatsLocation `json:"location,omitempty"`
Name *string `json:"name,omitempty"`
UserID string `json:"user_id"`
UserSessionID string `json:"user_session_id"`
}
CallStatsMapSubscriber defines model for CallStatsMapSubscriber.
type CallStatsMapSubscribers ¶
type CallStatsMapSubscribers struct {
Locations []CallStatsMapLocation `json:"locations"`
Participants *[]CallStatsMapSubscriber `json:"participants,omitempty"`
}
CallStatsMapSubscribers defines model for CallStatsMapSubscribers.
type CallStatsParticipant ¶
type CallStatsParticipant struct {
LatestActivityAt *Time `json:"latest_activity_at,omitempty"`
Name *string `json:"name,omitempty"`
Roles *[]string `json:"roles,omitempty"`
Sessions []CallStatsParticipantSession `json:"sessions"`
UserID string `json:"user_id"`
}
CallStatsParticipant defines model for CallStatsParticipant.
type CallStatsParticipantCounts ¶
type CallStatsParticipantCounts struct {
AverageJitterMs *int `json:"average_jitter_ms,omitempty"`
AverageLatencyMs *int `json:"average_latency_ms,omitempty"`
AvgUserRating *float64 `json:"avg_user_rating,omitempty"`
CallEventCount *int32 `json:"call_event_count,omitempty"`
CqScore *int32 `json:"cq_score,omitempty"`
LiveSessions int32 `json:"live_sessions"`
MaxFreezesDurationMs *int `json:"max_freezes_duration_ms,omitempty"`
MinUserRating *int32 `json:"min_user_rating,omitempty"`
Participants int32 `json:"participants"`
PeakConcurrentSessions int32 `json:"peak_concurrent_sessions"`
PeakConcurrentUsers int32 `json:"peak_concurrent_users"`
Publishers int32 `json:"publishers"`
Sessions int32 `json:"sessions"`
SfusUsed int32 `json:"sfus_used"`
TotalParticipantDuration *int64 `json:"total_participant_duration,omitempty"`
}
CallStatsParticipantCounts defines model for CallStatsParticipantCounts.
type CallStatsParticipantSession ¶
type CallStatsParticipantSession struct {
Browser *string `json:"browser,omitempty"`
BrowserVersion *string `json:"browser_version,omitempty"`
CqScore *int32 `json:"cq_score,omitempty"`
CurrentIP *string `json:"current_ip,omitempty"`
CurrentSfu *string `json:"current_sfu,omitempty"`
DistanceToSfuKilometers *float64 `json:"distance_to_sfu_kilometers,omitempty"`
EndedAt *Time `json:"ended_at,omitempty"`
FreezesDurationMs *int `json:"freezes_duration_ms,omitempty"`
Ingress *string `json:"ingress,omitempty"`
IsLive bool `json:"is_live"`
JitterMs *int `json:"jitter_ms,omitempty"`
LatencyMs *int `json:"latency_ms,omitempty"`
Location *CallStatsLocation `json:"location,omitempty"`
Os *string `json:"os,omitempty"`
PublishedTracks PublishedTrackFlags `json:"published_tracks"`
PublisherType *string `json:"publisher_type,omitempty"`
Sdk *string `json:"sdk,omitempty"`
SdkVersion *string `json:"sdk_version,omitempty"`
StartedAt *Time `json:"started_at,omitempty"`
UnifiedSessionID *string `json:"unified_session_id,omitempty"`
UserSessionID string `json:"user_session_id"`
WebrtcVersion *string `json:"webrtc_version,omitempty"`
}
CallStatsParticipantSession defines model for CallStatsParticipantSession.
type CallStatsReportReadyEvent ¶
type CallStatsReportReadyEvent struct {
CallCid string `json:"call_cid"`
Counts CallStatsParticipantCounts `json:"counts"`
CreatedAt Time `json:"created_at"`
// IsTrimmed Whether participants_overview is truncated by the server-side limit
IsTrimmed *bool `json:"is_trimmed,omitempty"`
// ParticipantsOverview Top participant sessions overview
ParticipantsOverview *[]CallStatsParticipant `json:"participants_overview,omitempty"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// Type The type of event, "call.report_ready" in this case
Type string `json:"type"`
}
CallStatsReportReadyEvent This event is sent when the insights report is ready
func (CallStatsReportReadyEvent) GetEventType ¶
func (CallStatsReportReadyEvent) GetEventType() string
type CallStatsReportSummaryResponse ¶
type CallStatsReportSummaryResponse struct {
CallCid string `json:"call_cid"`
CallDurationSeconds int32 `json:"call_duration_seconds"`
CallSessionID string `json:"call_session_id"`
CallStatus string `json:"call_status"`
CreatedAt *Time `json:"created_at,omitempty"`
FirstStatsTime Time `json:"first_stats_time"`
MinUserRating *int32 `json:"min_user_rating,omitempty"`
QualityScore *int32 `json:"quality_score,omitempty"`
}
CallStatsReportSummaryResponse defines model for CallStatsReportSummaryResponse.
type CallStatsSessionResponse ¶
type CallStatsSessionResponse struct {
CallEndedAt *Time `json:"call_ended_at,omitempty"`
CallID string `json:"call_id"`
CallSessionID string `json:"call_session_id"`
CallStartedAt *Time `json:"call_started_at,omitempty"`
CallType string `json:"call_type"`
Counts CallStatsParticipantCounts `json:"counts"`
GeneratedAt Time `json:"generated_at"`
}
CallStatsSessionResponse defines model for CallStatsSessionResponse.
type CallTranscription ¶
type CallTranscription struct {
EndTime Time `json:"end_time"`
Filename string `json:"filename"`
SessionID string `json:"session_id"`
StartTime Time `json:"start_time"`
URL string `json:"url"`
}
CallTranscription CallTranscription represents a transcription of a call.
type CallTranscriptionFailedEvent ¶
type CallTranscriptionFailedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// Error The error message detailing why transcription failed.
Error *string `json:"error,omitempty"`
// Type The type of event: "call.transcription_failed" in this case
Type string `json:"type"`
}
CallTranscriptionFailedEvent This event is sent when call transcription has failed
func (CallTranscriptionFailedEvent) GetEventType ¶
func (CallTranscriptionFailedEvent) GetEventType() string
type CallTranscriptionReadyEvent ¶
type CallTranscriptionReadyEvent struct {
CallCid string `json:"call_cid"`
// CallTranscription CallTranscription represents a transcription of a call.
CallTranscription CallTranscription `json:"call_transcription"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// Type The type of event: "call.transcription_ready" in this case
Type string `json:"type"`
}
CallTranscriptionReadyEvent This event is sent when call transcription is ready
func (CallTranscriptionReadyEvent) GetEventType ¶
func (CallTranscriptionReadyEvent) GetEventType() string
type CallTranscriptionStartedEvent ¶
type CallTranscriptionStartedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// Type The type of event: "call.transcription_started" in this case
Type string `json:"type"`
}
CallTranscriptionStartedEvent This event is sent when call transcription has started
func (CallTranscriptionStartedEvent) GetEventType ¶
func (CallTranscriptionStartedEvent) GetEventType() string
type CallTranscriptionStoppedEvent ¶
type CallTranscriptionStoppedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
EgressID string `json:"egress_id"`
// Type The type of event: "call.transcription_stopped" in this case
Type string `json:"type"`
}
CallTranscriptionStoppedEvent This event is sent when call transcription has stopped
func (CallTranscriptionStoppedEvent) GetEventType ¶
func (CallTranscriptionStoppedEvent) GetEventType() string
type CallUpdatedEvent ¶
type CallUpdatedEvent struct {
// Call Represents a call
Call CallResponse `json:"call"`
CallCid string `json:"call_cid"`
// CapabilitiesByRole The capabilities by role for this call
CapabilitiesByRole map[string][]string `json:"capabilities_by_role"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.updated" in this case
Type string `json:"type"`
}
CallUpdatedEvent This event is sent when a call is updated, clients should use this update the local state of the call. This event also contains the capabilities by role for the call, clients should update the own_capability for the current.
func (CallUpdatedEvent) GetEventType ¶
func (CallUpdatedEvent) GetEventType() string
type CallUserFeedbackSubmittedEvent ¶
type CallUserFeedbackSubmittedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Custom Custom data provided by the user
Custom *map[string]interface{} `json:"custom,omitempty"`
// Rating The rating given by the user (1-5)
Rating int32 `json:"rating"`
// Reason The reason provided by the user for the rating
Reason *string `json:"reason,omitempty"`
Sdk *string `json:"sdk,omitempty"`
SdkVersion *string `json:"sdk_version,omitempty"`
// SessionID Call session ID
SessionID string `json:"session_id"`
// Type The type of event, "call.user_feedback" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
CallUserFeedbackSubmittedEvent This event is sent when a user submits feedback for a call.
func (CallUserFeedbackSubmittedEvent) GetEventType ¶
func (CallUserFeedbackSubmittedEvent) GetEventType() string
type CallUserMutedEvent ¶
type CallUserMutedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
FromUserID string `json:"from_user_id"`
MutedUserIds []string `json:"muted_user_ids"`
Reason string `json:"reason"`
// Type The type of event: "call.user_muted" in this case
Type string `json:"type"`
}
CallUserMutedEvent This event is sent when a call member is muted
func (CallUserMutedEvent) GetEventType ¶
func (CallUserMutedEvent) GetEventType() string
type CallsPerDayReport ¶
type CallsPerDayReport struct {
Count int64 `json:"count"`
}
CallsPerDayReport defines model for CallsPerDayReport.
type CallsPerDayReportResponse ¶
type CallsPerDayReportResponse struct {
Daily []DailyAggregateCallsPerDayReportResponse `json:"daily"`
}
CallsPerDayReportResponse defines model for CallsPerDayReportResponse.
type ChatActivityStatsResponse ¶
type ChatActivityStatsResponse struct {
Messages *MessageStatsResponse `json:"Messages,omitempty"`
}
ChatActivityStatsResponse defines model for ChatActivityStatsResponse.
type ChatPreferencesResponse ¶
type ChatPreferencesResponse struct {
ChannelMentions *string `json:"channel_mentions,omitempty"`
DefaultPreference *string `json:"default_preference,omitempty"`
DirectMentions *string `json:"direct_mentions,omitempty"`
GroupMentions *string `json:"group_mentions,omitempty"`
HereMentions *string `json:"here_mentions,omitempty"`
RoleMentions *string `json:"role_mentions,omitempty"`
ThreadReplies *string `json:"thread_replies,omitempty"`
}
ChatPreferencesResponse defines model for ChatPreferencesResponse.
type ClientEvent ¶
type ClientEvent struct {
// CallSessionID Call session ID associated with the attempt. Required on every event except CoordinatorJoin initiation and CoordinatorJoin failure (where the call session is not yet established); optional on MediaDevicePermission.
CallSessionID *string `json:"call_session_id,omitempty"`
// CameraPermissionStatus Camera permission status: INITIATED, FAILED, GRANTED, or NOT_INITIATED. Required on every MediaDevicePermission event.
CameraPermissionStatus *string `json:"camera_permission_status,omitempty"`
// CoordinatorConnectID UUID generated by the client and shared across every event of the same coordinator connection. Required on every event except JoinInitiated, which is reported before a coordinator connection exists.
CoordinatorConnectID *string `json:"coordinator_connect_id,omitempty"`
// ElapsedTime Milliseconds elapsed between the stage attempt's initiation and this event.
ElapsedTime *int64 `json:"elapsed_time,omitempty"`
// EventType Whether the event marks the start (initiated) or resolution (completed) of a stage attempt, or another event-specific value
EventType *string `json:"event_type,omitempty"`
// IceState Terminal state of the peer connection. Required on PeerConnectionConnect failure.
IceState *string `json:"ice_state,omitempty"`
// ID Call ID associated with the event. Required on every stage except CoordinatorWS, where it is optional.
ID *string `json:"id,omitempty"`
// JoinAttemptID UUID generated by the client and shared across JoinInitiated and the join-lifecycle events (CoordinatorJoin, WSJoin, PeerConnectionConnect) of the same overall join attempt. Required on every join event except CoordinatorWS, which is reported before a join attempt is established.
JoinAttemptID *string `json:"join_attempt_id,omitempty"`
// JoinReason Reason the client initiated the join. Optional on CoordinatorJoin events; empty when not provided.
JoinReason *string `json:"join_reason,omitempty"`
// MicrophonePermissionStatus Microphone permission status: INITIATED, FAILED, GRANTED, or NOT_INITIATED. Required on every MediaDevicePermission event.
MicrophonePermissionStatus *string `json:"microphone_permission_status,omitempty"`
// Outcome Resolution of a completed event: success or failure. Required on completed join events; forbidden on initiated join events.
Outcome *string `json:"outcome,omitempty"`
// PeerConnection Which peer connection a PeerConnectionConnect event reports on: publish or subscribe. Required on every PeerConnectionConnect event.
PeerConnection *string `json:"peer_connection,omitempty"`
// PreviouslyConnectedTimestamp UTC timestamp at which the ICE connection was established earlier in the session, when applicable
PreviouslyConnectedTimestamp *Time `json:"previously_connected_timestamp,omitempty"`
// RetryCountAttempt Total in-stage retries the client made before resolving (0–1000). Required on completed join events.
RetryCountAttempt *int32 `json:"retry_count_attempt,omitempty"`
// RetryFailureCode Failure code string. Required on CoordinatorJoin, CoordinatorWS, WSJoin, and PeerConnectionConnect failure.
RetryFailureCode *string `json:"retry_failure_code,omitempty"`
// RetryFailureReason Failure reason string. Required on CoordinatorJoin, CoordinatorWS, WSJoin, and PeerConnectionConnect failure.
RetryFailureReason *string `json:"retry_failure_reason,omitempty"`
ScreenShareStatus *string `json:"screen_share_status,omitempty"`
// SdkVersion Version of the client SDK
SdkVersion *string `json:"sdk_version,omitempty"`
// SfuID Identifier of the SFU the client was attempting to connect to. Required on WSJoin and PeerConnectionConnect failure, and on FirstAudioFrame and FirstVideoFrame.
SfuID *string `json:"sfu_id,omitempty"`
// Stage Discriminator identifying the event kind. JoinInitiated marks the start of a join attempt; join-lifecycle events use CoordinatorJoin, CoordinatorWS, WSJoin, or PeerConnectionConnect; media-readiness events use FirstAudioFrame or FirstVideoFrame; MediaDevicePermission reports device permission results; other values denote generic client events.
Stage *string `json:"stage,omitempty"`
// StageID UUID generated by the client at initiation. Identical on the matching completion event. Absent on JoinInitiated.
StageID *string `json:"stage_id,omitempty"`
// Timestamp UTC timestamp at which the event was recorded
Timestamp *Time `json:"timestamp,omitempty"`
// TrackID Identifier of the media track the frame belongs to. Required on FirstVideoFrame; optional on FirstAudioFrame.
TrackID *string `json:"track_id,omitempty"`
// Type Call type associated with the event. Required on every stage except CoordinatorWS, where it is optional.
Type *string `json:"type,omitempty"`
// UserAgent User agent string of the client SDK
UserAgent *string `json:"user_agent,omitempty"`
// UserID ID of the user the event was recorded for
UserID *string `json:"user_id,omitempty"`
// WasPreviouslyConnected Whether the ICE connection had been established earlier in the same session. Required on every PeerConnectionConnect event so reconnects can be distinguished from fresh connects.
WasPreviouslyConnected *bool `json:"was_previously_connected,omitempty"`
}
ClientEvent A single client-side telemetry event. JoinInitiated is the top-level marker emitted when a user begins a join attempt and carries only join_attempt_id (no stage_id or coordinator_connect_id). When stage is CoordinatorJoin, CoordinatorWS, WSJoin, or PeerConnectionConnect the event reports a join-lifecycle attempt; initiation and completion of a stage attempt share the same stage_id. FirstAudioFrame and FirstVideoFrame report media readiness and only ever carry an initiated event. MediaDevicePermission reports the result of requesting screen-share, microphone, and camera permissions. Other stage values denote generic client events.
type ClosedCaptionEvent ¶
type ClosedCaptionEvent struct {
CallCid string `json:"call_cid"`
// ClosedCaption CallClosedCaption represents a closed caption of a call.
ClosedCaption CallClosedCaption `json:"closed_caption"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.closed_caption" in this case
Type string `json:"type"`
}
ClosedCaptionEvent This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen
func (ClosedCaptionEvent) GetEventType ¶
func (ClosedCaptionEvent) GetEventType() string
type CollectUserFeedbackJSONRequestBody ¶
type CollectUserFeedbackJSONRequestBody = CollectUserFeedbackRequest
CollectUserFeedbackJSONRequestBody defines body for CollectUserFeedback for application/json ContentType.
type CollectUserFeedbackRequest ¶
type CollectUserFeedbackRequest struct {
Custom *map[string]interface{} `json:"custom,omitempty"`
Rating int32 `json:"rating"`
Reason *string `json:"reason,omitempty"`
Sdk string `json:"sdk"`
SdkVersion string `json:"sdk_version"`
UserSessionID *string `json:"user_session_id,omitempty"`
}
CollectUserFeedbackRequest defines model for CollectUserFeedbackRequest.
type CollectUserFeedbackResponse ¶
type CollectUserFeedbackResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
CollectUserFeedbackResponse Basic response information
type CompositeRecordingResponse ¶
type CompositeRecordingResponse struct {
Status string `json:"status"`
}
CompositeRecordingResponse defines model for CompositeRecordingResponse.
type ConcurrencyMinute ¶
type ConcurrencyMinute struct {
Joins int32 `json:"joins"`
Leaves int32 `json:"leaves"`
Max int32 `json:"max"`
Min int32 `json:"min"`
Minute string `json:"minute"`
}
ConcurrencyMinute defines model for ConcurrencyMinute.
type ConnectUserDetailsRequest ¶
type ConnectUserDetailsRequest struct {
Custom *map[string]interface{} `json:"custom,omitempty"`
ID string `json:"id"`
Image *string `json:"image,omitempty"`
Invisible *bool `json:"invisible,omitempty"`
Language *string `json:"language,omitempty"`
Name *string `json:"name,omitempty"`
PrivacySettings *PrivacySettingsResponse `json:"privacy_settings,omitempty"`
}
ConnectUserDetailsRequest defines model for ConnectUserDetailsRequest.
type ConnectedEvent ¶
type ConnectedEvent struct {
// ConnectionID The connection_id for this client
ConnectionID string `json:"connection_id"`
CreatedAt Time `json:"created_at"`
Me OwnUserResponse `json:"me"`
// Type The type of event: "connection.ok" in this case
Type string `json:"type"`
}
ConnectedEvent This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server
func (ConnectedEvent) GetEventType ¶
func (ConnectedEvent) GetEventType() string
type ConnectionErrorEvent ¶
type ConnectionErrorEvent struct {
ConnectionID string `json:"connection_id"`
CreatedAt Time `json:"created_at"`
Error APIError `json:"error"`
// Type The type of event: "connection.ok" in this case
Type string `json:"type"`
}
ConnectionErrorEvent This event is sent when the WS connection fails
func (ConnectionErrorEvent) GetEventType ¶
func (ConnectionErrorEvent) GetEventType() string
type CoordinatesResponse ¶
type CoordinatesResponse struct {
// Latitude Latitude coordinate
Latitude float64 `json:"latitude"`
// Longitude Longitude coordinate
Longitude float64 `json:"longitude"`
}
CoordinatesResponse Geographic coordinates
type CountByMinuteResponse ¶
CountByMinuteResponse defines model for CountByMinuteResponse.
type Coverage ¶
type Coverage struct {
Absent []AbsentMetric `json:"absent"`
MetricsPct MetricsPct `json:"metrics_pct"`
PublisherEncodingProfiles int32 `json:"publisher_encoding_profiles"`
}
Coverage defines model for Coverage.
type CreateDeviceJSONRequestBody ¶
type CreateDeviceJSONRequestBody = CreateDeviceRequest
CreateDeviceJSONRequestBody defines body for CreateDevice for application/json ContentType.
type CreateDeviceRequest ¶
type CreateDeviceRequest struct {
// HardwareID Stable physical device identifier used to deduplicate pushes across push providers (e.g. APNs VoIP and Firebase on the same iOS device). Distinct from 'id', which is the push token.
HardwareID *string `json:"hardware_id,omitempty"`
// ID Device ID
ID string `json:"id"`
// PushProvider Push provider
PushProvider CreateDeviceRequestPushProvider `json:"push_provider"`
// PushProviderName Push provider name
PushProviderName *string `json:"push_provider_name,omitempty"`
// VoipToken When true the token is for Apple VoIP push notifications
VoipToken *bool `json:"voip_token,omitempty"`
}
CreateDeviceRequest Create device request
type CreateDeviceRequestPushProvider ¶
type CreateDeviceRequestPushProvider string
CreateDeviceRequestPushProvider Push provider
const ( Apn CreateDeviceRequestPushProvider = "apn" Firebase CreateDeviceRequestPushProvider = "firebase" Huawei CreateDeviceRequestPushProvider = "huawei" Xiaomi CreateDeviceRequestPushProvider = "xiaomi" )
Defines values for CreateDeviceRequestPushProvider.
func (CreateDeviceRequestPushProvider) Valid ¶
func (e CreateDeviceRequestPushProvider) Valid() bool
Valid indicates whether the value is a known member of the CreateDeviceRequestPushProvider enum.
type CreateGuestJSONRequestBody ¶
type CreateGuestJSONRequestBody = CreateGuestRequest
CreateGuestJSONRequestBody defines body for CreateGuest for application/json ContentType.
type CreateGuestRequest ¶
type CreateGuestRequest struct {
// User User request object
User UserRequest `json:"user"`
}
CreateGuestRequest defines model for CreateGuestRequest.
type CreateGuestResponse ¶
type CreateGuestResponse struct {
// AccessToken the access token to authenticate the user
AccessToken string `json:"access_token"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
// User User response object
User UserResponse `json:"user"`
}
CreateGuestResponse defines model for CreateGuestResponse.
type Credentials ¶
type Credentials struct {
IceServers []ICEServerResponse `json:"ice_servers"`
Server SFUResponse `json:"server"`
Token string `json:"token"`
}
Credentials defines model for Credentials.
type CustomVideoEvent ¶
type CustomVideoEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Custom Custom data for this object
Custom map[string]interface{} `json:"custom"`
// Type The type of event, "custom" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
CustomVideoEvent A custom event, this event is used to send custom events to other participants in the call.
func (CustomVideoEvent) GetEventType ¶
func (CustomVideoEvent) GetEventType() string
type DailyAggregateCallDurationReportResponse ¶
type DailyAggregateCallDurationReportResponse struct {
Date string `json:"date"`
Report CallDurationReport `json:"report"`
}
DailyAggregateCallDurationReportResponse defines model for DailyAggregateCallDurationReportResponse.
type DailyAggregateCallParticipantCountReportResponse ¶
type DailyAggregateCallParticipantCountReportResponse struct {
Date string `json:"date"`
Report CallParticipantCountReport `json:"report"`
}
DailyAggregateCallParticipantCountReportResponse defines model for DailyAggregateCallParticipantCountReportResponse.
type DailyAggregateCallsPerDayReportResponse ¶
type DailyAggregateCallsPerDayReportResponse struct {
Date string `json:"date"`
Report CallsPerDayReport `json:"report"`
}
DailyAggregateCallsPerDayReportResponse defines model for DailyAggregateCallsPerDayReportResponse.
type DailyAggregateQualityScoreReportResponse ¶
type DailyAggregateQualityScoreReportResponse struct {
Date string `json:"date"`
Report QualityScoreReport `json:"report"`
}
DailyAggregateQualityScoreReportResponse defines model for DailyAggregateQualityScoreReportResponse.
type DailyAggregateSDKUsageReportResponse ¶
type DailyAggregateSDKUsageReportResponse struct {
Date string `json:"date"`
Report SDKUsageReport `json:"report"`
}
DailyAggregateSDKUsageReportResponse defines model for DailyAggregateSDKUsageReportResponse.
type DailyAggregateUserFeedbackReportResponse ¶
type DailyAggregateUserFeedbackReportResponse struct {
Date string `json:"date"`
Report UserFeedbackReport `json:"report"`
}
DailyAggregateUserFeedbackReportResponse defines model for DailyAggregateUserFeedbackReportResponse.
type DeleteCallJSONRequestBody ¶
type DeleteCallJSONRequestBody = DeleteCallRequest
DeleteCallJSONRequestBody defines body for DeleteCall for application/json ContentType.
type DeleteCallRequest ¶
type DeleteCallRequest struct {
// Hard if true the call will be hard deleted along with all related data
Hard *bool `json:"hard,omitempty"`
}
DeleteCallRequest DeleteCallRequest is the payload for deleting a call.
type DeleteCallResponse ¶
type DeleteCallResponse struct {
// Call Represents a call
Call CallResponse `json:"call"`
Duration string `json:"duration"`
TaskID *string `json:"task_id,omitempty"`
}
DeleteCallResponse DeleteCallResponse is the payload for deleting a call.
type DeleteDeviceParams ¶
type DeleteDeviceParams struct {
ID string `form:"id" json:"id"`
}
DeleteDeviceParams defines parameters for DeleteDevice.
type DeleteRecordingResponse ¶
type DeleteRecordingResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
DeleteRecordingResponse Response for DeleteRecording
type DeleteTranscriptionResponse ¶
type DeleteTranscriptionResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
DeleteTranscriptionResponse DeleteTranscriptionResponse is the payload for deleting a transcription.
type DeliveryZoneSegment ¶
type DeliveryZoneSegment struct {
AvgQualityScore *float64 `json:"avg_quality_score,omitempty"`
Key string `json:"key"`
Outlier bool `json:"outlier"`
P5QualityScore *float64 `json:"p5_quality_score,omitempty"`
PoorPct *float64 `json:"poor_pct,omitempty"`
Sessions int32 `json:"sessions"`
}
DeliveryZoneSegment defines model for DeliveryZoneSegment.
type DeviceResponse ¶
type DeviceResponse struct {
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
// Disabled Whether device is disabled or not
Disabled *bool `json:"disabled,omitempty"`
// DisabledReason Reason explaining why device had been disabled
DisabledReason *string `json:"disabled_reason,omitempty"`
// HardwareID Stable physical device identifier used to deduplicate pushes across push providers
HardwareID *string `json:"hardware_id,omitempty"`
// ID Device ID
ID string `json:"id"`
// PushProvider Push provider
PushProvider string `json:"push_provider"`
// PushProviderName Push provider name
PushProviderName *string `json:"push_provider_name,omitempty"`
// UserID User ID
UserID string `json:"user_id"`
// Voip When true the token is for Apple VoIP push notifications
Voip *bool `json:"voip,omitempty"`
}
DeviceResponse Response for Device
type EdgeResponse ¶
type EdgeResponse struct {
ContinentCode string `json:"continent_code"`
CountryIsoCode string `json:"country_iso_code"`
Green int32 `json:"green"`
ID string `json:"id"`
LatencyTestURL string `json:"latency_test_url"`
Latitude float64 `json:"latitude"`
Longitude float64 `json:"longitude"`
Red int32 `json:"red"`
SubdivisionIsoCode string `json:"subdivision_iso_code"`
Yellow int32 `json:"yellow"`
}
EdgeResponse defines model for EdgeResponse.
type EgressHLSResponse ¶
type EgressHLSResponse struct {
PlaylistURL string `json:"playlist_url"`
Status string `json:"status"`
}
EgressHLSResponse defines model for EgressHLSResponse.
type EgressRTMPResponse ¶
type EgressRTMPResponse struct {
Name string `json:"name"`
StartedAt Time `json:"started_at"`
StreamKey *string `json:"stream_key,omitempty"`
StreamURL *string `json:"stream_url,omitempty"`
}
EgressRTMPResponse defines model for EgressRTMPResponse.
type EgressResponse ¶
type EgressResponse struct {
Broadcasting bool `json:"broadcasting"`
CompositeRecording *CompositeRecordingResponse `json:"composite_recording,omitempty"`
FrameRecording *FrameRecordingResponse `json:"frame_recording,omitempty"`
Hls *EgressHLSResponse `json:"hls,omitempty"`
IndividualRecording *IndividualRecordingResponse `json:"individual_recording,omitempty"`
RawRecording *RawRecordingResponse `json:"raw_recording,omitempty"`
Rtmps []EgressRTMPResponse `json:"rtmps"`
}
EgressResponse defines model for EgressResponse.
type EncodingProfile ¶
type EncodingProfile struct {
AvgSendKbps *int64 `json:"avg_send_kbps,omitempty"`
Codec *string `json:"codec,omitempty"`
EncoderImpl *string `json:"encoder_impl,omitempty"`
FpsP10 *int64 `json:"fps_p10,omitempty"`
FpsP50 *int64 `json:"fps_p50,omitempty"`
GetstatsSnapshots int32 `json:"getstats_snapshots"`
HardwareEncode *bool `json:"hardware_encode,omitempty"`
LadderType *string `json:"ladder_type,omitempty"`
PowerEfficient *bool `json:"power_efficient,omitempty"`
QualityLimitationDurationsS map[string]int64 `json:"quality_limitation_durations_s"`
QualityLimitationSamples map[string]int64 `json:"quality_limitation_samples"`
Resolution *string `json:"resolution,omitempty"`
SimulcastLayers *int32 `json:"simulcast_layers,omitempty"`
SourceFile string `json:"source_file"`
SvcModes []string `json:"svc_modes"`
}
EncodingProfile defines model for EncodingProfile.
type EncryptionSettingsRequest ¶
type EncryptionSettingsRequest struct {
// Mode Encryption mode. One of: available, disabled, auto-on
Mode *EncryptionSettingsRequestMode `json:"mode,omitempty"`
}
EncryptionSettingsRequest defines model for EncryptionSettingsRequest.
type EncryptionSettingsRequestMode ¶
type EncryptionSettingsRequestMode string
EncryptionSettingsRequestMode Encryption mode. One of: available, disabled, auto-on
const ( EncryptionSettingsRequestModeAutoOn EncryptionSettingsRequestMode = "auto-on" EncryptionSettingsRequestModeAvailable EncryptionSettingsRequestMode = "available" EncryptionSettingsRequestModeDisabled EncryptionSettingsRequestMode = "disabled" )
Defines values for EncryptionSettingsRequestMode.
func (EncryptionSettingsRequestMode) Valid ¶
func (e EncryptionSettingsRequestMode) Valid() bool
Valid indicates whether the value is a known member of the EncryptionSettingsRequestMode enum.
type EncryptionSettingsResponse ¶
type EncryptionSettingsResponse struct {
// Mode the resolved encryption mode for the call
Mode EncryptionSettingsResponseMode `json:"mode"`
}
EncryptionSettingsResponse EncryptionSettings is the payload for end-to-end encryption settings
type EncryptionSettingsResponseMode ¶
type EncryptionSettingsResponseMode string
EncryptionSettingsResponseMode the resolved encryption mode for the call
const ( EncryptionSettingsResponseModeAutoOn EncryptionSettingsResponseMode = "auto-on" EncryptionSettingsResponseModeAvailable EncryptionSettingsResponseMode = "available" EncryptionSettingsResponseModeDisabled EncryptionSettingsResponseMode = "disabled" )
Defines values for EncryptionSettingsResponseMode.
func (EncryptionSettingsResponseMode) Valid ¶
func (e EncryptionSettingsResponseMode) Valid() bool
Valid indicates whether the value is a known member of the EncryptionSettingsResponseMode enum.
type EndCallRequest ¶
type EndCallRequest = map[string]interface{}
EndCallRequest Request for ending a call
type EndCallResponse ¶
type EndCallResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
EndCallResponse Response for ending a call
type FeedsPreferencesResponse ¶
type FeedsPreferencesResponse struct {
Comment *string `json:"comment,omitempty"`
CommentMention *string `json:"comment_mention,omitempty"`
CommentReaction *string `json:"comment_reaction,omitempty"`
CommentReply *string `json:"comment_reply,omitempty"`
CustomActivityTypes *map[string]string `json:"custom_activity_types,omitempty"`
Follow *string `json:"follow,omitempty"`
Mention *string `json:"mention,omitempty"`
Reaction *string `json:"reaction,omitempty"`
}
FeedsPreferencesResponse defines model for FeedsPreferencesResponse.
type FileUploadConfig ¶
type FileUploadConfig struct {
AllowedFileExtensions []string `json:"allowed_file_extensions"`
AllowedMimeTypes []string `json:"allowed_mime_types"`
BlockedFileExtensions []string `json:"blocked_file_extensions"`
BlockedMimeTypes []string `json:"blocked_mime_types"`
SizeLimit int32 `json:"size_limit"`
}
FileUploadConfig defines model for FileUploadConfig.
type FrameRecordingResponse ¶
type FrameRecordingResponse struct {
Status string `json:"status"`
}
FrameRecordingResponse defines model for FrameRecordingResponse.
type FrameRecordingSettingsRequest ¶
type FrameRecordingSettingsRequest struct {
CaptureIntervalInSeconds int32 `json:"capture_interval_in_seconds"`
Mode FrameRecordingSettingsRequestMode `json:"mode"`
Quality *FrameRecordingSettingsRequestQuality `json:"quality,omitempty"`
}
FrameRecordingSettingsRequest defines model for FrameRecordingSettingsRequest.
type FrameRecordingSettingsRequestMode ¶
type FrameRecordingSettingsRequestMode string
FrameRecordingSettingsRequestMode defines model for FrameRecordingSettingsRequest.Mode.
const ( FrameRecordingSettingsRequestModeAutoOn FrameRecordingSettingsRequestMode = "auto-on" FrameRecordingSettingsRequestModeAvailable FrameRecordingSettingsRequestMode = "available" FrameRecordingSettingsRequestModeDisabled FrameRecordingSettingsRequestMode = "disabled" )
Defines values for FrameRecordingSettingsRequestMode.
func (FrameRecordingSettingsRequestMode) Valid ¶
func (e FrameRecordingSettingsRequestMode) Valid() bool
Valid indicates whether the value is a known member of the FrameRecordingSettingsRequestMode enum.
type FrameRecordingSettingsRequestQuality ¶
type FrameRecordingSettingsRequestQuality string
FrameRecordingSettingsRequestQuality defines model for FrameRecordingSettingsRequest.Quality.
const ( FrameRecordingSettingsRequestQualityN1080P FrameRecordingSettingsRequestQuality = "1080p" FrameRecordingSettingsRequestQualityN1440P FrameRecordingSettingsRequestQuality = "1440p" FrameRecordingSettingsRequestQualityN360P FrameRecordingSettingsRequestQuality = "360p" FrameRecordingSettingsRequestQualityN480P FrameRecordingSettingsRequestQuality = "480p" FrameRecordingSettingsRequestQualityN720P FrameRecordingSettingsRequestQuality = "720p" )
Defines values for FrameRecordingSettingsRequestQuality.
func (FrameRecordingSettingsRequestQuality) Valid ¶
func (e FrameRecordingSettingsRequestQuality) Valid() bool
Valid indicates whether the value is a known member of the FrameRecordingSettingsRequestQuality enum.
type FrameRecordingSettingsResponse ¶
type FrameRecordingSettingsResponse struct {
CaptureIntervalInSeconds int32 `json:"capture_interval_in_seconds"`
Mode FrameRecordingSettingsResponseMode `json:"mode"`
Quality *string `json:"quality,omitempty"`
}
FrameRecordingSettingsResponse defines model for FrameRecordingSettingsResponse.
type FrameRecordingSettingsResponseMode ¶
type FrameRecordingSettingsResponseMode string
FrameRecordingSettingsResponseMode defines model for FrameRecordingSettingsResponse.Mode.
const ( FrameRecordingSettingsResponseModeAutoOn FrameRecordingSettingsResponseMode = "auto-on" FrameRecordingSettingsResponseModeAvailable FrameRecordingSettingsResponseMode = "available" FrameRecordingSettingsResponseModeDisabled FrameRecordingSettingsResponseMode = "disabled" )
Defines values for FrameRecordingSettingsResponseMode.
func (FrameRecordingSettingsResponseMode) Valid ¶
func (e FrameRecordingSettingsResponseMode) Valid() bool
Valid indicates whether the value is a known member of the FrameRecordingSettingsResponseMode enum.
type GeofenceSettingsRequest ¶
type GeofenceSettingsRequest struct {
Names *[]string `json:"names,omitempty"`
}
GeofenceSettingsRequest defines model for GeofenceSettingsRequest.
type GeofenceSettingsResponse ¶
type GeofenceSettingsResponse struct {
Names []string `json:"names"`
}
GeofenceSettingsResponse defines model for GeofenceSettingsResponse.
type GetCallParams ¶
type GetCallParams struct {
ConnectionID *string `form:"connection_id,omitempty" json:"connection_id,omitempty"`
MembersLimit *int32 `form:"members_limit,omitempty" json:"members_limit,omitempty"`
Ring *bool `form:"ring,omitempty" json:"ring,omitempty"`
Notify *bool `form:"notify,omitempty" json:"notify,omitempty"`
Video *bool `form:"video,omitempty" json:"video,omitempty"`
}
GetCallParams defines parameters for GetCall.
type GetCallParticipantSessionMetricsParams ¶
type GetCallParticipantSessionMetricsParams struct {
Since *Time `form:"since,omitempty" json:"since,omitempty"`
Until *Time `form:"until,omitempty" json:"until,omitempty"`
}
GetCallParticipantSessionMetricsParams defines parameters for GetCallParticipantSessionMetrics.
type GetCallParticipantSessionMetricsResponse ¶
type GetCallParticipantSessionMetricsResponse struct {
Client *SessionClient `json:"client,omitempty"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
IsPublisher *bool `json:"is_publisher,omitempty"`
IsSubscriber *bool `json:"is_subscriber,omitempty"`
JoinedAt *Time `json:"joined_at,omitempty"`
PublishedTracks *[]PublishedTrackMetrics `json:"published_tracks,omitempty"`
PublisherType *string `json:"publisher_type,omitempty"`
UserID *string `json:"user_id,omitempty"`
UserSessionID *string `json:"user_session_id,omitempty"`
}
GetCallParticipantSessionMetricsResponse Basic response information
type GetCallReportParams ¶
type GetCallReportParams struct {
SessionID *string `form:"session_id,omitempty" json:"session_id,omitempty"`
}
GetCallReportParams defines parameters for GetCallReport.
type GetCallReportResponse ¶
type GetCallReportResponse struct {
ChatActivity *ChatActivityStatsResponse `json:"chat_activity,omitempty"`
Digest *BroadcastDigest `json:"digest,omitempty"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Report ReportResponse `json:"report"`
Session *CallSessionResponse `json:"session,omitempty"`
SessionID string `json:"session_id"`
VideoReactions *[]*VideoReactionsResponse `json:"video_reactions,omitempty"`
}
GetCallReportResponse Basic response information
type GetCallResponse ¶
type GetCallResponse struct {
// Call Represents a call
Call CallResponse `json:"call"`
Duration string `json:"duration"`
Members []MemberResponse `json:"members"`
// Membership MemberResponse is the payload for a member of a call.
Membership *MemberResponse `json:"membership,omitempty"`
OwnCapabilities []OwnCapability `json:"own_capabilities"`
}
GetCallResponse defines model for GetCallResponse.
type GetCallSessionParticipantStatsDetailsParams ¶
type GetCallSessionParticipantStatsDetailsParams struct {
Since *string `form:"since,omitempty" json:"since,omitempty"`
Until *string `form:"until,omitempty" json:"until,omitempty"`
MaxPoints *int32 `form:"max_points,omitempty" json:"max_points,omitempty"`
}
GetCallSessionParticipantStatsDetailsParams defines parameters for GetCallSessionParticipantStatsDetails.
type GetCallSessionParticipantStatsDetailsResponse ¶
type GetCallSessionParticipantStatsDetailsResponse struct {
CallID string `json:"call_id"`
CallSessionID string `json:"call_session_id"`
CallType string `json:"call_type"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Publisher *ParticipantSeriesPublisherStats `json:"publisher,omitempty"`
Subscriber *ParticipantSeriesSubscriberStats `json:"subscriber,omitempty"`
Timeframe *ParticipantSeriesTimeframe `json:"timeframe,omitempty"`
User *ParticipantSeriesUserStats `json:"user,omitempty"`
UserID string `json:"user_id"`
UserSessionID string `json:"user_session_id"`
}
GetCallSessionParticipantStatsDetailsResponse Basic response information
type GetCallSessionParticipantStatsTimelineParams ¶
type GetCallSessionParticipantStatsTimelineParams struct {
StartTime *string `form:"start_time,omitempty" json:"start_time,omitempty"`
EndTime *string `form:"end_time,omitempty" json:"end_time,omitempty"`
Severity *[]string `form:"severity,omitempty" json:"severity,omitempty"`
}
GetCallSessionParticipantStatsTimelineParams defines parameters for GetCallSessionParticipantStatsTimeline.
type GetCallStatsMapParams ¶
type GetCallStatsMapParams struct {
StartTime *Time `form:"start_time,omitempty" json:"start_time,omitempty"`
EndTime *Time `form:"end_time,omitempty" json:"end_time,omitempty"`
ExcludePublishers *bool `form:"exclude_publishers,omitempty" json:"exclude_publishers,omitempty"`
ExcludeSubscribers *bool `form:"exclude_subscribers,omitempty" json:"exclude_subscribers,omitempty"`
ExcludeSfus *bool `form:"exclude_sfus,omitempty" json:"exclude_sfus,omitempty"`
}
GetCallStatsMapParams defines parameters for GetCallStatsMap.
type GetEdgesResponse ¶
type GetEdgesResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Edges []EdgeResponse `json:"edges"`
}
GetEdgesResponse Basic response information
type GetOrCreateCallJSONRequestBody ¶
type GetOrCreateCallJSONRequestBody = GetOrCreateCallRequest
GetOrCreateCallJSONRequestBody defines body for GetOrCreateCall for application/json ContentType.
type GetOrCreateCallParams ¶
type GetOrCreateCallParams struct {
ConnectionID *string `form:"connection_id,omitempty" json:"connection_id,omitempty"`
}
GetOrCreateCallParams defines parameters for GetOrCreateCall.
type GetOrCreateCallRequest ¶
type GetOrCreateCallRequest struct {
// Data CallRequest is the payload for creating a call.
Data *CallRequest `json:"data,omitempty"`
MembersLimit *int32 `json:"members_limit,omitempty"`
// Notify if provided it sends a notification event to the members for this call
Notify *bool `json:"notify,omitempty"`
// Ring if provided it sends a ring event to the members for this call
Ring *bool `json:"ring,omitempty"`
Video *bool `json:"video,omitempty"`
}
GetOrCreateCallRequest defines model for GetOrCreateCallRequest.
type GetOrCreateCallResponse ¶
type GetOrCreateCallResponse struct {
// Call Represents a call
Call CallResponse `json:"call"`
Created bool `json:"created"`
Duration string `json:"duration"`
Members []MemberResponse `json:"members"`
// Membership MemberResponse is the payload for a member of a call.
Membership *MemberResponse `json:"membership,omitempty"`
OwnCapabilities []OwnCapability `json:"own_capabilities"`
}
GetOrCreateCallResponse defines model for GetOrCreateCallResponse.
type GoLiveJSONRequestBody ¶
type GoLiveJSONRequestBody = GoLiveRequest
GoLiveJSONRequestBody defines body for GoLive for application/json ContentType.
type GoLiveRequest ¶
type GoLiveRequest struct {
RecordingStorageName *string `json:"recording_storage_name,omitempty"`
StartClosedCaption *bool `json:"start_closed_caption,omitempty"`
StartCompositeRecording *bool `json:"start_composite_recording,omitempty"`
StartHls *bool `json:"start_hls,omitempty"`
StartIndividualRecording *bool `json:"start_individual_recording,omitempty"`
StartRawRecording *bool `json:"start_raw_recording,omitempty"`
StartRecording *bool `json:"start_recording,omitempty"`
StartTranscription *bool `json:"start_transcription,omitempty"`
TranscriptionStorageName *string `json:"transcription_storage_name,omitempty"`
}
GoLiveRequest defines model for GoLiveRequest.
type GoLiveResponse ¶
type GoLiveResponse struct {
// Call Represents a call
Call CallResponse `json:"call"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
GoLiveResponse Basic response information
type GroupedStatsResponse ¶
GroupedStatsResponse defines model for GroupedStatsResponse.
type HLSSettingsRequest ¶
type HLSSettingsRequest struct {
// AutoOn Whether HLS broadcasting should start automatically
AutoOn *bool `json:"auto_on,omitempty"`
// Enabled Whether HLS broadcasting is enabled
Enabled *bool `json:"enabled,omitempty"`
// QualityTracks Quality tracks for HLS. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560
QualityTracks []HLSSettingsRequestQualityTracks `json:"quality_tracks"`
}
HLSSettingsRequest defines model for HLSSettingsRequest.
type HLSSettingsRequestQualityTracks ¶
type HLSSettingsRequestQualityTracks string
HLSSettingsRequestQualityTracks defines model for HLSSettingsRequest.QualityTracks.
const ( HLSSettingsRequestQualityTracksN1080P HLSSettingsRequestQualityTracks = "1080p" HLSSettingsRequestQualityTracksN1440P HLSSettingsRequestQualityTracks = "1440p" HLSSettingsRequestQualityTracksN360P HLSSettingsRequestQualityTracks = "360p" HLSSettingsRequestQualityTracksN480P HLSSettingsRequestQualityTracks = "480p" HLSSettingsRequestQualityTracksN720P HLSSettingsRequestQualityTracks = "720p" HLSSettingsRequestQualityTracksPortrait1080X1920 HLSSettingsRequestQualityTracks = "portrait-1080x1920" HLSSettingsRequestQualityTracksPortrait1440X2560 HLSSettingsRequestQualityTracks = "portrait-1440x2560" HLSSettingsRequestQualityTracksPortrait360X640 HLSSettingsRequestQualityTracks = "portrait-360x640" HLSSettingsRequestQualityTracksPortrait480X854 HLSSettingsRequestQualityTracks = "portrait-480x854" HLSSettingsRequestQualityTracksPortrait720X1280 HLSSettingsRequestQualityTracks = "portrait-720x1280" )
Defines values for HLSSettingsRequestQualityTracks.
func (HLSSettingsRequestQualityTracks) Valid ¶
func (e HLSSettingsRequestQualityTracks) Valid() bool
Valid indicates whether the value is a known member of the HLSSettingsRequestQualityTracks enum.
type HLSSettingsResponse ¶
type HLSSettingsResponse struct {
AutoOn bool `json:"auto_on"`
Enabled bool `json:"enabled"`
QualityTracks []string `json:"quality_tracks"`
}
HLSSettingsResponse HLSSettings is the payload for HLS settings
type HealthCheckEvent ¶
type HealthCheckEvent struct {
Cid *string `json:"cid,omitempty"`
ConnectionID string `json:"connection_id"`
CreatedAt Time `json:"created_at"`
Custom map[string]interface{} `json:"custom"`
ReceivedAt *Time `json:"received_at,omitempty"`
Type string `json:"type"`
}
HealthCheckEvent defines model for HealthCheckEvent.
func (HealthCheckEvent) GetEventType ¶
func (HealthCheckEvent) GetEventType() string
type ICEServerResponse ¶
type ICEServerResponse struct {
// Password ICE server password
Password string `json:"password"`
// Urls ICE server URLs
Urls []string `json:"urls"`
// Username ICE server username
Username string `json:"username"`
}
ICEServerResponse ICE server configuration for WebRTC connections
type Incident ¶
type Incident struct {
From string `json:"from"`
PeakConcurrency int32 `json:"peak_concurrency"`
To string `json:"to"`
ViewersInterrupted int32 `json:"viewers_interrupted"`
}
Incident defines model for Incident.
type IndividualRecordingResponse ¶
type IndividualRecordingResponse struct {
Status string `json:"status"`
}
IndividualRecordingResponse defines model for IndividualRecordingResponse.
type IndividualRecordingSettingsRequest ¶
type IndividualRecordingSettingsRequest struct {
// Mode Recording mode. One of: available, disabled, auto-on
Mode IndividualRecordingSettingsRequestMode `json:"mode"`
// OutputTypes Output types to include: audio_only, video_only, audio_video, screenshare_audio_only, screenshare_video_only, screenshare_audio_video
OutputTypes *[]IndividualRecordingSettingsRequestOutputTypes `json:"output_types,omitempty"`
}
IndividualRecordingSettingsRequest defines model for IndividualRecordingSettingsRequest.
type IndividualRecordingSettingsRequestMode ¶
type IndividualRecordingSettingsRequestMode string
IndividualRecordingSettingsRequestMode Recording mode. One of: available, disabled, auto-on
const ( IndividualRecordingSettingsRequestModeAutoOn IndividualRecordingSettingsRequestMode = "auto-on" IndividualRecordingSettingsRequestModeAvailable IndividualRecordingSettingsRequestMode = "available" IndividualRecordingSettingsRequestModeDisabled IndividualRecordingSettingsRequestMode = "disabled" )
Defines values for IndividualRecordingSettingsRequestMode.
func (IndividualRecordingSettingsRequestMode) Valid ¶
func (e IndividualRecordingSettingsRequestMode) Valid() bool
Valid indicates whether the value is a known member of the IndividualRecordingSettingsRequestMode enum.
type IndividualRecordingSettingsRequestOutputTypes ¶
type IndividualRecordingSettingsRequestOutputTypes string
IndividualRecordingSettingsRequestOutputTypes defines model for IndividualRecordingSettingsRequest.OutputTypes.
const ( AudioOnly IndividualRecordingSettingsRequestOutputTypes = "audio_only" AudioVideo IndividualRecordingSettingsRequestOutputTypes = "audio_video" VideoOnly IndividualRecordingSettingsRequestOutputTypes = "video_only" )
Defines values for IndividualRecordingSettingsRequestOutputTypes.
func (IndividualRecordingSettingsRequestOutputTypes) Valid ¶
func (e IndividualRecordingSettingsRequestOutputTypes) Valid() bool
Valid indicates whether the value is a known member of the IndividualRecordingSettingsRequestOutputTypes enum.
type IndividualRecordingSettingsResponse ¶
type IndividualRecordingSettingsResponse struct {
Mode IndividualRecordingSettingsResponseMode `json:"mode"`
OutputTypes *[]string `json:"output_types,omitempty"`
}
IndividualRecordingSettingsResponse defines model for IndividualRecordingSettingsResponse.
type IndividualRecordingSettingsResponseMode ¶
type IndividualRecordingSettingsResponseMode string
IndividualRecordingSettingsResponseMode defines model for IndividualRecordingSettingsResponse.Mode.
const ( IndividualRecordingSettingsResponseModeAutoOn IndividualRecordingSettingsResponseMode = "auto-on" IndividualRecordingSettingsResponseModeAvailable IndividualRecordingSettingsResponseMode = "available" IndividualRecordingSettingsResponseModeDisabled IndividualRecordingSettingsResponseMode = "disabled" )
Defines values for IndividualRecordingSettingsResponseMode.
func (IndividualRecordingSettingsResponseMode) Valid ¶
func (e IndividualRecordingSettingsResponseMode) Valid() bool
Valid indicates whether the value is a known member of the IndividualRecordingSettingsResponseMode enum.
type IngressAudioEncodingOptionsRequest ¶
type IngressAudioEncodingOptionsRequest struct {
Bitrate int `json:"bitrate"`
Channels IngressAudioEncodingOptionsRequestChannels `json:"channels"`
EnableDtx *bool `json:"enable_dtx,omitempty"`
}
IngressAudioEncodingOptionsRequest defines model for IngressAudioEncodingOptionsRequest.
type IngressAudioEncodingOptionsRequestChannels ¶
type IngressAudioEncodingOptionsRequestChannels int32
IngressAudioEncodingOptionsRequestChannels defines model for IngressAudioEncodingOptionsRequest.Channels.
const ( N1 IngressAudioEncodingOptionsRequestChannels = 1 N2 IngressAudioEncodingOptionsRequestChannels = 2 )
Defines values for IngressAudioEncodingOptionsRequestChannels.
func (IngressAudioEncodingOptionsRequestChannels) Valid ¶
func (e IngressAudioEncodingOptionsRequestChannels) Valid() bool
Valid indicates whether the value is a known member of the IngressAudioEncodingOptionsRequestChannels enum.
type IngressAudioEncodingResponse ¶
type IngressAudioEncodingResponse struct {
Bitrate int32 `json:"bitrate"`
Channels int32 `json:"channels"`
EnableDtx bool `json:"enable_dtx"`
}
IngressAudioEncodingResponse defines model for IngressAudioEncodingResponse.
type IngressErrorEvent ¶
type IngressErrorEvent struct {
CallCid string `json:"call_cid"`
// Code Error code
Code *string `json:"code,omitempty"`
CreatedAt Time `json:"created_at"`
// Error Human-readable error message
Error string `json:"error"`
// IngressStreamID Unique identifier for the stream
IngressStreamID string `json:"ingress_stream_id"`
// Type The type of event: "ingress.error" in this case
Type string `json:"type"`
// UserID User who was streaming
UserID string `json:"user_id"`
}
IngressErrorEvent This event is sent when a critical error occurs that breaks the streaming pipeline
func (IngressErrorEvent) GetEventType ¶
func (IngressErrorEvent) GetEventType() string
type IngressSettingsRequest ¶
type IngressSettingsRequest struct {
AudioEncodingOptions *IngressAudioEncodingOptionsRequest `json:"audio_encoding_options,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
VideoEncodingOptions *map[string]IngressVideoEncodingOptionsRequest `json:"video_encoding_options,omitempty"`
}
IngressSettingsRequest defines model for IngressSettingsRequest.
type IngressSettingsResponse ¶
type IngressSettingsResponse struct {
AudioEncodingOptions *IngressAudioEncodingResponse `json:"audio_encoding_options,omitempty"`
Enabled bool `json:"enabled"`
VideoEncodingOptions *map[string]IngressVideoEncodingResponse `json:"video_encoding_options,omitempty"`
}
IngressSettingsResponse defines model for IngressSettingsResponse.
type IngressSourceRequest ¶
type IngressSourceRequest struct {
Fps IngressSourceRequestFps `json:"fps"`
Height int `json:"height"`
Width int `json:"width"`
}
IngressSourceRequest defines model for IngressSourceRequest.
type IngressSourceRequestFps ¶
type IngressSourceRequestFps int
IngressSourceRequestFps defines model for IngressSourceRequest.Fps.
const ( N30 IngressSourceRequestFps = 30 N60 IngressSourceRequestFps = 60 )
Defines values for IngressSourceRequestFps.
func (IngressSourceRequestFps) Valid ¶
func (e IngressSourceRequestFps) Valid() bool
Valid indicates whether the value is a known member of the IngressSourceRequestFps enum.
type IngressSourceResponse ¶
type IngressSourceResponse struct {
Fps int `json:"fps"`
Height int `json:"height"`
Width int `json:"width"`
}
IngressSourceResponse defines model for IngressSourceResponse.
type IngressStartedEvent ¶
type IngressStartedEvent struct {
CallCid string `json:"call_cid"`
// ClientIP Client IP address
ClientIP *string `json:"client_ip,omitempty"`
// ClientName Streaming client software name (e.g., 'OBS Studio')
ClientName *string `json:"client_name,omitempty"`
CreatedAt Time `json:"created_at"`
// IngressStreamID Unique identifier for this stream
IngressStreamID string `json:"ingress_stream_id"`
// PublisherType Streaming protocol (e.g., 'rtmps', 'srt', 'rtmp', 'rtsp')
PublisherType string `json:"publisher_type"`
// Type The type of event: "ingress.started" in this case
Type string `json:"type"`
// UserID User who started the stream
UserID string `json:"user_id"`
// Version Client software version
Version *string `json:"version,omitempty"`
}
IngressStartedEvent This event is sent when a user begins streaming into a call
func (IngressStartedEvent) GetEventType ¶
func (IngressStartedEvent) GetEventType() string
type IngressStoppedEvent ¶
type IngressStoppedEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// IngressStreamID Unique identifier for the stream
IngressStreamID string `json:"ingress_stream_id"`
// Type The type of event: "ingress.stopped" in this case
Type string `json:"type"`
// UserID User who was streaming
UserID string `json:"user_id"`
}
IngressStoppedEvent This event is sent when streaming stops due to user action or call ended
func (IngressStoppedEvent) GetEventType ¶
func (IngressStoppedEvent) GetEventType() string
type IngressVideoEncodingOptionsRequest ¶
type IngressVideoEncodingOptionsRequest struct {
Layers []*IngressVideoLayerRequest `json:"layers"`
Source IngressSourceRequest `json:"source"`
}
IngressVideoEncodingOptionsRequest defines model for IngressVideoEncodingOptionsRequest.
type IngressVideoEncodingResponse ¶
type IngressVideoEncodingResponse struct {
Layers []*IngressVideoLayerResponse `json:"layers"`
Source IngressSourceResponse `json:"source"`
}
IngressVideoEncodingResponse defines model for IngressVideoEncodingResponse.
type IngressVideoLayerRequest ¶
type IngressVideoLayerRequest struct {
Bitrate int32 `json:"bitrate"`
Codec IngressVideoLayerRequestCodec `json:"codec"`
FrameRateLimit int `json:"frame_rate_limit"`
MaxDimension int `json:"max_dimension"`
MinDimension int `json:"min_dimension"`
}
IngressVideoLayerRequest defines model for IngressVideoLayerRequest.
type IngressVideoLayerRequestCodec ¶
type IngressVideoLayerRequestCodec string
IngressVideoLayerRequestCodec defines model for IngressVideoLayerRequest.Codec.
const ( H264 IngressVideoLayerRequestCodec = "h264" Vp8 IngressVideoLayerRequestCodec = "vp8" )
Defines values for IngressVideoLayerRequestCodec.
func (IngressVideoLayerRequestCodec) Valid ¶
func (e IngressVideoLayerRequestCodec) Valid() bool
Valid indicates whether the value is a known member of the IngressVideoLayerRequestCodec enum.
type IngressVideoLayerResponse ¶
type IngressVideoLayerResponse struct {
Bitrate int `json:"bitrate"`
Codec string `json:"codec"`
FrameRateLimit int `json:"frame_rate_limit"`
MaxDimension int `json:"max_dimension"`
MinDimension int `json:"min_dimension"`
}
IngressVideoLayerResponse defines model for IngressVideoLayerResponse.
type JoinCallJSONRequestBody ¶
type JoinCallJSONRequestBody = JoinCallRequest
JoinCallJSONRequestBody defines body for JoinCall for application/json ContentType.
type JoinCallParams ¶
type JoinCallParams struct {
ConnectionID *string `form:"connection_id,omitempty" json:"connection_id,omitempty"`
}
JoinCallParams defines parameters for JoinCall.
type JoinCallRequest ¶
type JoinCallRequest struct {
// Create if true the call will be created if it doesn't exist
Create *bool `json:"create,omitempty"`
// Data CallRequest is the payload for creating a call.
Data *CallRequest `json:"data,omitempty"`
// E2Ee the encryption mode the client intends to use for this join; the join is rejected if it does not match the call's encryption configuration
E2Ee *bool `json:"e2ee,omitempty"`
// HintHighScaleLivestreamPublisher if true, the participant will be marked as publsihing to large audience
HintHighScaleLivestreamPublisher *bool `json:"hint_high_scale_livestream_publisher,omitempty"`
Location string `json:"location"`
MembersLimit *int32 `json:"members_limit,omitempty"`
// MigratingFrom If the participant is migrating from another SFU, then this is the ID of the previous SFU
MigratingFrom *string `json:"migrating_from,omitempty"`
// MigratingFromList List of SFU IDs to exclude when picking a new SFU for the participant
MigratingFromList *[]string `json:"migrating_from_list,omitempty"`
Notify *bool `json:"notify,omitempty"`
// Ring if true and the call is created, the notification will include ring=true
Ring *bool `json:"ring,omitempty"`
Video *bool `json:"video,omitempty"`
}
JoinCallRequest defines model for JoinCallRequest.
type JoinCallResponse ¶
type JoinCallResponse struct {
// Call Represents a call
Call CallResponse `json:"call"`
Created bool `json:"created"`
Credentials Credentials `json:"credentials"`
Duration string `json:"duration"`
Members []MemberResponse `json:"members"`
// Membership MemberResponse is the payload for a member of a call.
Membership *MemberResponse `json:"membership,omitempty"`
OwnCapabilities []OwnCapability `json:"own_capabilities"`
StatsOptions StatsOptions `json:"stats_options"`
}
JoinCallResponse defines model for JoinCallResponse.
type Joins ¶
type Joins struct {
DisconnectReasons map[string]int64 `json:"disconnect_reasons"`
FailureStages map[string]int64 `json:"failure_stages"`
JoinAttempts *int64 `json:"join_attempts,omitempty"`
JoinSuccessRate *float64 `json:"join_success_rate,omitempty"`
Reason string `json:"reason"`
}
Joins defines model for Joins.
type KickUserJSONRequestBody ¶
type KickUserJSONRequestBody = KickUserRequest
KickUserJSONRequestBody defines body for KickUser for application/json ContentType.
type KickUserRequest ¶
type KickUserRequest struct {
// Block If true, also block the user from rejoining the call
Block *bool `json:"block,omitempty"`
// UserID The user to kick
UserID string `json:"user_id"`
}
KickUserRequest KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.
type KickUserResponse ¶
type KickUserResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
KickUserResponse KickUserResponse is the payload for kicking a user from a call.
type KickedUserEvent ¶
type KickedUserEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// KickedByUser User response object
KickedByUser *UserResponse `json:"kicked_by_user,omitempty"`
// Type The type of event: "call.kicked_user" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
KickedUserEvent This event is sent to call participants to notify when a user is kicked from a call. Clients should make the kicked user leave the call UI.
func (KickedUserEvent) GetEventType ¶
func (KickedUserEvent) GetEventType() string
type LayoutSettingsRequest ¶
type LayoutSettingsRequest struct {
DetectOrientation *bool `json:"detect_orientation,omitempty"`
ExternalAppURL *string `json:"external_app_url,omitempty"`
ExternalCSSURL *string `json:"external_css_url,omitempty"`
Name LayoutSettingsRequestName `json:"name"`
Options *map[string]interface{} `json:"options,omitempty"`
}
LayoutSettingsRequest defines model for LayoutSettingsRequest.
type LayoutSettingsRequestName ¶
type LayoutSettingsRequestName string
LayoutSettingsRequestName defines model for LayoutSettingsRequest.Name.
const ( Custom LayoutSettingsRequestName = "custom" Grid LayoutSettingsRequestName = "grid" Mobile LayoutSettingsRequestName = "mobile" SingleParticipant LayoutSettingsRequestName = "single-participant" Spotlight LayoutSettingsRequestName = "spotlight" )
Defines values for LayoutSettingsRequestName.
func (LayoutSettingsRequestName) Valid ¶
func (e LayoutSettingsRequestName) Valid() bool
Valid indicates whether the value is a known member of the LayoutSettingsRequestName enum.
type LimitsSettingsRequest ¶
type LimitsSettingsRequest struct {
MaxDurationSeconds *int32 `json:"max_duration_seconds,omitempty"`
MaxParticipants *int32 `json:"max_participants,omitempty"`
MaxParticipantsExcludeOwner *bool `json:"max_participants_exclude_owner,omitempty"`
MaxParticipantsExcludeRoles *[]string `json:"max_participants_exclude_roles,omitempty"`
}
LimitsSettingsRequest defines model for LimitsSettingsRequest.
type LimitsSettingsResponse ¶
type LimitsSettingsResponse struct {
MaxDurationSeconds *int32 `json:"max_duration_seconds,omitempty"`
MaxParticipants *int32 `json:"max_participants,omitempty"`
MaxParticipantsExcludeOwner *bool `json:"max_participants_exclude_owner,omitempty"`
MaxParticipantsExcludeRoles []string `json:"max_participants_exclude_roles"`
}
LimitsSettingsResponse defines model for LimitsSettingsResponse.
type ListDevicesResponse ¶
type ListDevicesResponse struct {
// Devices List of devices
Devices []DeviceResponse `json:"devices"`
Duration string `json:"duration"`
}
ListDevicesResponse List devices response
type ListRecordingsResponse ¶
type ListRecordingsResponse struct {
Duration string `json:"duration"`
Recordings []CallRecording `json:"recordings"`
}
ListRecordingsResponse Response for listing recordings
type ListTranscriptionsResponse ¶
type ListTranscriptionsResponse struct {
Duration string `json:"duration"`
// Transcriptions List of transcriptions for the call
Transcriptions []CallTranscription `json:"transcriptions"`
}
ListTranscriptionsResponse defines model for ListTranscriptionsResponse.
type LocationResponse ¶
type LocationResponse struct {
// ContinentCode Continent code
ContinentCode string `json:"continent_code"`
// CountryIsoCode Country ISO code
CountryIsoCode string `json:"country_iso_code"`
// SubdivisionIsoCode Subdivision ISO code
SubdivisionIsoCode string `json:"subdivision_iso_code"`
}
LocationResponse Geographic location metadata
type MemberRequest ¶
type MemberRequest struct {
// Custom Custom data for this object
Custom *map[string]interface{} `json:"custom,omitempty"`
Role *string `json:"role,omitempty"`
UserID string `json:"user_id"`
}
MemberRequest MemberRequest is the payload for adding a member to a call.
type MemberResponse ¶
type MemberResponse struct {
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
// Custom Custom member response data
Custom map[string]interface{} `json:"custom"`
// DeletedAt Date/time of deletion
DeletedAt *Time `json:"deleted_at,omitempty"`
Role *string `json:"role,omitempty"`
// UpdatedAt Date/time of the last update
UpdatedAt Time `json:"updated_at"`
// User User response object
User UserResponse `json:"user"`
UserID string `json:"user_id"`
}
MemberResponse MemberResponse is the payload for a member of a call.
type MessageStatsResponse ¶
type MessageStatsResponse struct {
CountOverTime *[]*CountByMinuteResponse `json:"count_over_time,omitempty"`
}
MessageStatsResponse defines model for MessageStatsResponse.
type MetricDescriptor ¶
type MetricDescriptor struct {
Description *string `json:"description,omitempty"`
Label string `json:"label"`
Unit *string `json:"unit,omitempty"`
}
MetricDescriptor defines model for MetricDescriptor.
type MetricThreshold ¶
type MetricThreshold struct {
Level string `json:"level"`
Operator string `json:"operator"`
Value float64 `json:"value"`
ValueUnit *string `json:"value_unit,omitempty"`
WindowSeconds *int32 `json:"window_seconds,omitempty"`
}
MetricThreshold defines model for MetricThreshold.
type MetricTimeSeries ¶
type MetricTimeSeries struct {
DataPoints *[][]float64 `json:"data_points,omitempty"`
}
MetricTimeSeries defines model for MetricTimeSeries.
type MetricsPct ¶
type MetricsPct struct {
Freezes *float64 `json:"freezes,omitempty"`
Geo *float64 `json:"geo,omitempty"`
Jitter *float64 `json:"jitter,omitempty"`
Latency *float64 `json:"latency,omitempty"`
QualityScore *float64 `json:"quality_score,omitempty"`
}
MetricsPct defines model for MetricsPct.
type MuteUsersJSONRequestBody ¶
type MuteUsersJSONRequestBody = MuteUsersRequest
MuteUsersJSONRequestBody defines body for MuteUsers for application/json ContentType.
type MuteUsersRequest ¶
type MuteUsersRequest struct {
Audio *bool `json:"audio,omitempty"`
MuteAllUsers *bool `json:"mute_all_users,omitempty"`
UserIds *[]string `json:"user_ids,omitempty"`
Video *bool `json:"video,omitempty"`
}
MuteUsersRequest defines model for MuteUsersRequest.
type MuteUsersResponse ¶
type MuteUsersResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
MuteUsersResponse MuteUsersResponse is the response payload for the mute users endpoint.
type NetworkMetricsReportResponse ¶
type NetworkMetricsReportResponse struct {
AverageConnectionTime *float64 `json:"average_connection_time,omitempty"`
AverageJitter *float64 `json:"average_jitter,omitempty"`
AverageLatency *float64 `json:"average_latency,omitempty"`
AverageTimeToReconnect *float64 `json:"average_time_to_reconnect,omitempty"`
}
NetworkMetricsReportResponse defines model for NetworkMetricsReportResponse.
type NoiseCancellationSettings ¶
type NoiseCancellationSettings struct {
Mode NoiseCancellationSettingsMode `json:"mode"`
}
NoiseCancellationSettings defines model for NoiseCancellationSettings.
type NoiseCancellationSettingsMode ¶
type NoiseCancellationSettingsMode string
NoiseCancellationSettingsMode defines model for NoiseCancellationSettings.Mode.
const ( NoiseCancellationSettingsModeAutoOn NoiseCancellationSettingsMode = "auto-on" NoiseCancellationSettingsModeAvailable NoiseCancellationSettingsMode = "available" NoiseCancellationSettingsModeDisabled NoiseCancellationSettingsMode = "disabled" )
Defines values for NoiseCancellationSettingsMode.
func (NoiseCancellationSettingsMode) Valid ¶
func (e NoiseCancellationSettingsMode) Valid() bool
Valid indicates whether the value is a known member of the NoiseCancellationSettingsMode enum.
type OwnCapability ¶
type OwnCapability string
OwnCapability All possibility of string to use
const ( OwnCapabilityBlockUsers OwnCapability = "block-users" OwnCapabilityChangeMaxDuration OwnCapability = "change-max-duration" OwnCapabilityCreateCall OwnCapability = "create-call" OwnCapabilityCreateReaction OwnCapability = "create-reaction" OwnCapabilityEnableNoiseCancellation OwnCapability = "enable-noise-cancellation" OwnCapabilityEndCall OwnCapability = "end-call" OwnCapabilityJoinBackstage OwnCapability = "join-backstage" OwnCapabilityJoinCall OwnCapability = "join-call" OwnCapabilityJoinEndedCall OwnCapability = "join-ended-call" OwnCapabilityKickUser OwnCapability = "kick-user" OwnCapabilityMuteUsers OwnCapability = "mute-users" OwnCapabilityPinForEveryone OwnCapability = "pin-for-everyone" OwnCapabilityReadCall OwnCapability = "read-call" OwnCapabilityRemoveCallMember OwnCapability = "remove-call-member" OwnCapabilitySendAudio OwnCapability = "send-audio" OwnCapabilitySendClosedCaptionsCall OwnCapability = "send-closed-captions-call" OwnCapabilitySendVideo OwnCapability = "send-video" OwnCapabilityStartBroadcastCall OwnCapability = "start-broadcast-call" OwnCapabilityStartClosedCaptionsCall OwnCapability = "start-closed-captions-call" OwnCapabilityStartFrameRecordCall OwnCapability = "start-frame-record-call" OwnCapabilityStartIndividualRecordCall OwnCapability = "start-individual-record-call" OwnCapabilityStartRawRecordCall OwnCapability = "start-raw-record-call" OwnCapabilityStartRecordCall OwnCapability = "start-record-call" OwnCapabilityStartTranscriptionCall OwnCapability = "start-transcription-call" OwnCapabilityStopBroadcastCall OwnCapability = "stop-broadcast-call" OwnCapabilityStopClosedCaptionsCall OwnCapability = "stop-closed-captions-call" OwnCapabilityStopFrameRecordCall OwnCapability = "stop-frame-record-call" OwnCapabilityStopIndividualRecordCall OwnCapability = "stop-individual-record-call" OwnCapabilityStopRawRecordCall OwnCapability = "stop-raw-record-call" OwnCapabilityStopRecordCall OwnCapability = "stop-record-call" OwnCapabilityStopTranscriptionCall OwnCapability = "stop-transcription-call" OwnCapabilityUpdateCall OwnCapability = "update-call" OwnCapabilityUpdateCallMember OwnCapability = "update-call-member" OwnCapabilityUpdateCallPermissions OwnCapability = "update-call-permissions" OwnCapabilityUpdateCallSettings OwnCapability = "update-call-settings" )
Defines values for OwnCapability.
func (OwnCapability) Valid ¶
func (e OwnCapability) Valid() bool
Valid indicates whether the value is a known member of the OwnCapability enum.
type OwnUserResponse ¶
type OwnUserResponse struct {
AvgResponseTime *int32 `json:"avg_response_time,omitempty"`
BlockedUserIds *[]string `json:"blocked_user_ids,omitempty"`
CreatedAt Time `json:"created_at"`
Custom map[string]interface{} `json:"custom"`
DeactivatedAt *Time `json:"deactivated_at,omitempty"`
DeletedAt *Time `json:"deleted_at,omitempty"`
Devices []DeviceResponse `json:"devices"`
ID string `json:"id"`
Image *string `json:"image,omitempty"`
Language string `json:"language"`
LastActive *Time `json:"last_active,omitempty"`
Name *string `json:"name,omitempty"`
PrivacySettings *PrivacySettingsResponse `json:"privacy_settings,omitempty"`
PushPreferences *PushPreferencesResponse `json:"push_preferences,omitempty"`
RevokeTokensIssuedBefore *Time `json:"revoke_tokens_issued_before,omitempty"`
Role string `json:"role"`
Teams []string `json:"teams"`
TeamsRole *map[string]string `json:"teams_role,omitempty"`
UpdatedAt Time `json:"updated_at"`
}
OwnUserResponse defines model for OwnUserResponse.
type ParticipantCountByMinuteResponse ¶
type ParticipantCountByMinuteResponse struct {
First int32 `json:"first"`
Last int32 `json:"last"`
Max int32 `json:"max"`
Min int32 `json:"min"`
StartTS Time `json:"start_ts"`
}
ParticipantCountByMinuteResponse defines model for ParticipantCountByMinuteResponse.
type ParticipantCountOverTimeResponse ¶
type ParticipantCountOverTimeResponse struct {
ByMinute *[]*ParticipantCountByMinuteResponse `json:"by_minute,omitempty"`
}
ParticipantCountOverTimeResponse defines model for ParticipantCountOverTimeResponse.
type ParticipantReportResponse ¶
type ParticipantReportResponse struct {
ByBrowser *[]*GroupedStatsResponse `json:"by_browser,omitempty"`
ByCountry *[]*GroupedStatsResponse `json:"by_country,omitempty"`
ByDevice *[]*GroupedStatsResponse `json:"by_device,omitempty"`
ByOperatingSystem *[]*GroupedStatsResponse `json:"by_operating_system,omitempty"`
CountOverTime *ParticipantCountOverTimeResponse `json:"count_over_time,omitempty"`
MaxConcurrent *int32 `json:"max_concurrent,omitempty"`
Publishers *PublisherStatsResponse `json:"publishers,omitempty"`
Subscribers *SubscriberStatsResponse `json:"subscribers,omitempty"`
Sum int32 `json:"sum"`
Unique int32 `json:"unique"`
}
ParticipantReportResponse defines model for ParticipantReportResponse.
type ParticipantSeriesPublisherStats ¶
type ParticipantSeriesPublisherStats struct {
Global *map[string][][]float64 `json:"global,omitempty"`
GlobalMeta *map[string]MetricDescriptor `json:"global_meta,omitempty"`
GlobalMetricsOrder *[]string `json:"global_metrics_order,omitempty"`
GlobalThresholds *map[string][]MetricThreshold `json:"global_thresholds,omitempty"`
Tracks *map[string][]ParticipantSeriesTrackMetrics `json:"tracks,omitempty"`
}
ParticipantSeriesPublisherStats defines model for ParticipantSeriesPublisherStats.
type ParticipantSeriesSubscriberStats ¶
type ParticipantSeriesSubscriberStats struct {
Global *map[string][][]float64 `json:"global,omitempty"`
GlobalMeta *map[string]MetricDescriptor `json:"global_meta,omitempty"`
GlobalMetricsOrder *[]string `json:"global_metrics_order,omitempty"`
GlobalThresholds *map[string][]MetricThreshold `json:"global_thresholds,omitempty"`
Subscriptions *[]ParticipantSeriesSubscriptionTrackMetrics `json:"subscriptions,omitempty"`
}
ParticipantSeriesSubscriberStats defines model for ParticipantSeriesSubscriberStats.
type ParticipantSeriesSubscriptionTrackMetrics ¶
type ParticipantSeriesSubscriptionTrackMetrics struct {
PublisherName *string `json:"publisher_name,omitempty"`
PublisherUserID string `json:"publisher_user_id"`
PublisherUserSessionID *string `json:"publisher_user_session_id,omitempty"`
Tracks *map[string][]ParticipantSeriesTrackMetrics `json:"tracks,omitempty"`
}
ParticipantSeriesSubscriptionTrackMetrics defines model for ParticipantSeriesSubscriptionTrackMetrics.
type ParticipantSeriesTimeframe ¶
type ParticipantSeriesTimeframe struct {
MaxPoints int32 `json:"max_points"`
Since Time `json:"since"`
StepSeconds int32 `json:"step_seconds"`
Until Time `json:"until"`
}
ParticipantSeriesTimeframe defines model for ParticipantSeriesTimeframe.
type ParticipantSeriesTrackMetrics ¶
type ParticipantSeriesTrackMetrics struct {
Codec *string `json:"codec,omitempty"`
Label *string `json:"label,omitempty"`
Metrics *map[string][][]float64 `json:"metrics,omitempty"`
MetricsMeta *map[string]MetricDescriptor `json:"metrics_meta,omitempty"`
MetricsOrder *[]string `json:"metrics_order,omitempty"`
Rid *string `json:"rid,omitempty"`
Thresholds *map[string][]MetricThreshold `json:"thresholds,omitempty"`
TrackID string `json:"track_id"`
TrackType *string `json:"track_type,omitempty"`
}
ParticipantSeriesTrackMetrics defines model for ParticipantSeriesTrackMetrics.
type ParticipantSeriesUserStats ¶
type ParticipantSeriesUserStats struct {
Metrics *map[string][][]float64 `json:"metrics,omitempty"`
MetricsMeta *map[string]MetricDescriptor `json:"metrics_meta,omitempty"`
MetricsOrder *[]string `json:"metrics_order,omitempty"`
Thresholds *map[string][]MetricThreshold `json:"thresholds,omitempty"`
}
ParticipantSeriesUserStats defines model for ParticipantSeriesUserStats.
type ParticipantSessionDetails ¶
type ParticipantSessionDetails struct {
DurationInSeconds *int64 `json:"duration_in_seconds,omitempty"`
JoinedAt *Time `json:"joined_at,omitempty"`
LeftAt *Time `json:"left_at,omitempty"`
PublisherType string `json:"publisher_type"`
Roles []string `json:"roles"`
UserID string `json:"user_id"`
UserSessionID string `json:"user_session_id"`
}
ParticipantSessionDetails defines model for ParticipantSessionDetails.
type PerSDKUsageReport ¶
type PerSDKUsageReport struct {
ByVersion map[string]int32 `json:"by_version"`
Total int32 `json:"total"`
}
PerSDKUsageReport defines model for PerSDKUsageReport.
type Percentiles ¶
Percentiles defines model for Percentiles.
type PermissionRequestEvent ¶
type PermissionRequestEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Permissions The list of permissions requested by the user
Permissions []string `json:"permissions"`
// Type The type of event: "call.permission_request" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
PermissionRequestEvent This event is sent when a user requests access to a feature on a call, clients receiving this event should display a permission request to the user
func (PermissionRequestEvent) GetEventType ¶
func (PermissionRequestEvent) GetEventType() string
type PinRequest ¶
type PinRequest struct {
// SessionID the session ID of the user who pinned the message
SessionID string `json:"session_id"`
// UserID the user ID of the user who pinned the message
UserID string `json:"user_id"`
}
PinRequest PinRequest is the payload for pinning a message.
type PinResponse ¶
type PinResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
PinResponse Basic response information
type PoorByCause ¶
type PoorByCause struct {
Delivery int32 `json:"delivery"`
Edge int32 `json:"edge"`
IsolatedLocal int32 `json:"isolated_local"`
Source int32 `json:"source"`
Unattributed int32 `json:"unattributed"`
}
PoorByCause defines model for PoorByCause.
type PoorTail ¶
type PoorTail struct {
HealthyPct *float64 `json:"healthy_pct,omitempty"`
HealthyViewers int32 `json:"healthy_viewers"`
Note string `json:"note"`
PoorByCause PoorByCause `json:"poor_by_cause"`
PoorTotal int32 `json:"poor_total"`
Supporting Supporting `json:"supporting"`
}
PoorTail defines model for PoorTail.
type PrivacySettingsResponse ¶
type PrivacySettingsResponse = map[string]interface{}
PrivacySettingsResponse defines model for PrivacySettingsResponse.
type PublishedTrackFlags ¶
PublishedTrackFlags defines model for PublishedTrackFlags.
type PublishedTrackMetrics ¶
type PublishedTrackMetrics struct {
Bitrate *MetricTimeSeries `json:"bitrate,omitempty"`
Codec *string `json:"codec,omitempty"`
Framerate *MetricTimeSeries `json:"framerate,omitempty"`
Resolution *ResolutionMetricsTimeSeries `json:"resolution,omitempty"`
TrackID *string `json:"track_id,omitempty"`
TrackType *string `json:"track_type,omitempty"`
Warnings *[]SessionWarningResponse `json:"warnings,omitempty"`
}
PublishedTrackMetrics defines model for PublishedTrackMetrics.
type PublisherSession ¶
type PublisherSession struct {
AvgJitterMs *float64 `json:"avg_jitter_ms,omitempty"`
Browser *string `json:"browser,omitempty"`
DeliveryZone *string `json:"delivery_zone,omitempty"`
DurationMin float64 `json:"duration_min"`
Encoding *EncodingProfile `json:"encoding,omitempty"`
Ingest *string `json:"ingest,omitempty"`
Os *string `json:"os,omitempty"`
SendQualityScore *float64 `json:"send_quality_score,omitempty"`
StartedOffsetMin float64 `json:"started_offset_min"`
Tool *string `json:"tool,omitempty"`
UserID string `json:"user_id"`
UserSessionID string `json:"user_session_id"`
}
PublisherSession defines model for PublisherSession.
type PublisherStatsResponse ¶
type PublisherStatsResponse struct {
ByTrack *[]*TrackStatsResponse `json:"by_track,omitempty"`
Total int32 `json:"total"`
Unique int32 `json:"unique"`
}
PublisherStatsResponse defines model for PublisherStatsResponse.
type PushPreferencesResponse ¶
type PushPreferencesResponse struct {
CallLevel *string `json:"call_level,omitempty"`
ChatLevel *string `json:"chat_level,omitempty"`
ChatPreferences *ChatPreferencesResponse `json:"chat_preferences,omitempty"`
DisabledUntil *Time `json:"disabled_until,omitempty"`
FeedsLevel *string `json:"feeds_level,omitempty"`
FeedsPreferences *FeedsPreferencesResponse `json:"feeds_preferences,omitempty"`
}
PushPreferencesResponse defines model for PushPreferencesResponse.
type Quality ¶
type Quality struct {
ConnectionAvgJitterMs Percentiles `json:"connection_avg_jitter_ms"`
ConnectionAvgLatencyMs Percentiles `json:"connection_avg_latency_ms"`
InterruptionIncidents []Incident `json:"interruption_incidents"`
P50QualityScore *float64 `json:"p50_quality_score,omitempty"`
P5QualityScore *float64 `json:"p5_quality_score,omitempty"`
ScoreBandsByConnectionPct ScoreBands `json:"score_bands_by_connection_pct"`
ScoreBandsByWatchTimePct ScoreBands `json:"score_bands_by_watch_time_pct"`
ViewerInterruptionNote string `json:"viewer_interruption_note"`
ViewerInterruptionRatePct *float64 `json:"viewer_interruption_rate_pct,omitempty"`
}
Quality defines model for Quality.
type QualityScoreReport ¶
type QualityScoreReport struct {
Histogram []ReportByHistogramBucket `json:"histogram"`
}
QualityScoreReport defines model for QualityScoreReport.
type QualityScoreReportResponse ¶
type QualityScoreReportResponse struct {
Daily []DailyAggregateQualityScoreReportResponse `json:"daily"`
}
QualityScoreReportResponse defines model for QualityScoreReportResponse.
type QueryAggregateCallStatsJSONRequestBody ¶
type QueryAggregateCallStatsJSONRequestBody = QueryAggregateCallStatsRequest
QueryAggregateCallStatsJSONRequestBody defines body for QueryAggregateCallStats for application/json ContentType.
type QueryAggregateCallStatsRequest ¶
type QueryAggregateCallStatsRequest struct {
From *string `json:"from,omitempty"`
ReportTypes *[]string `json:"report_types,omitempty"`
To *string `json:"to,omitempty"`
}
QueryAggregateCallStatsRequest defines model for QueryAggregateCallStatsRequest.
type QueryAggregateCallStatsResponse ¶
type QueryAggregateCallStatsResponse struct {
CallDurationReport *CallDurationReportResponse `json:"call_duration_report,omitempty"`
CallParticipantCountReport *CallParticipantCountReportResponse `json:"call_participant_count_report,omitempty"`
CallsPerDayReport *CallsPerDayReportResponse `json:"calls_per_day_report,omitempty"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
NetworkMetricsReport *NetworkMetricsReportResponse `json:"network_metrics_report,omitempty"`
QualityScoreReport *QualityScoreReportResponse `json:"quality_score_report,omitempty"`
SdkUsageReport *SDKUsageReportResponse `json:"sdk_usage_report,omitempty"`
UserFeedbackReport *UserFeedbackReportResponse `json:"user_feedback_report,omitempty"`
}
QueryAggregateCallStatsResponse Basic response information
type QueryCallMembersJSONRequestBody ¶
type QueryCallMembersJSONRequestBody = QueryCallMembersRequest
QueryCallMembersJSONRequestBody defines body for QueryCallMembers for application/json ContentType.
type QueryCallMembersRequest ¶
type QueryCallMembersRequest struct {
// FilterConditions Filter conditions to apply to the query
FilterConditions *map[string]interface{} `json:"filter_conditions,omitempty"`
ID string `json:"id"`
Limit *int32 `json:"limit,omitempty"`
Next *string `json:"next,omitempty"`
Prev *string `json:"prev,omitempty"`
// Sort Array of sort parameters
Sort *[]*SortParamRequest `json:"sort,omitempty"`
Type string `json:"type"`
}
QueryCallMembersRequest defines model for QueryCallMembersRequest.
type QueryCallMembersResponse ¶
type QueryCallMembersResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Members []MemberResponse `json:"members"`
Next *string `json:"next,omitempty"`
Prev *string `json:"prev,omitempty"`
}
QueryCallMembersResponse Basic response information
type QueryCallParticipantSessionsParams ¶
type QueryCallParticipantSessionsParams struct {
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
Prev *string `form:"prev,omitempty" json:"prev,omitempty"`
Next *string `form:"next,omitempty" json:"next,omitempty"`
FilterConditions *map[string]interface{} `form:"filter_conditions,omitempty" json:"filter_conditions,omitempty"`
}
QueryCallParticipantSessionsParams defines parameters for QueryCallParticipantSessions.
type QueryCallParticipantSessionsResponse ¶
type QueryCallParticipantSessionsResponse struct {
CallID string `json:"call_id"`
CallSessionID string `json:"call_session_id"`
CallType string `json:"call_type"`
// Duration Duration of the request in milliseconds
Duration int64 `json:"duration"`
Next *string `json:"next,omitempty"`
ParticipantsSessions []ParticipantSessionDetails `json:"participants_sessions"`
Prev *string `json:"prev,omitempty"`
Session *CallSessionResponse `json:"session,omitempty"`
TotalParticipantDuration int64 `json:"total_participant_duration"`
TotalParticipantSessions int32 `json:"total_participant_sessions"`
}
QueryCallParticipantSessionsResponse Basic response information
type QueryCallParticipantsJSONRequestBody ¶
type QueryCallParticipantsJSONRequestBody = QueryCallParticipantsRequest
QueryCallParticipantsJSONRequestBody defines body for QueryCallParticipants for application/json ContentType.
type QueryCallParticipantsParams ¶
type QueryCallParticipantsParams struct {
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}
QueryCallParticipantsParams defines parameters for QueryCallParticipants.
type QueryCallParticipantsRequest ¶
type QueryCallParticipantsRequest struct {
// FilterConditions Filter conditions to apply to the query
FilterConditions *map[string]interface{} `json:"filter_conditions,omitempty"`
}
QueryCallParticipantsRequest defines model for QueryCallParticipantsRequest.
type QueryCallParticipantsResponse ¶
type QueryCallParticipantsResponse struct {
// Call Represents a call
Call CallResponse `json:"call"`
Duration string `json:"duration"`
Members []MemberResponse `json:"members"`
// Membership MemberResponse is the payload for a member of a call.
Membership *MemberResponse `json:"membership,omitempty"`
OwnCapabilities []OwnCapability `json:"own_capabilities"`
// Participants List of call participants
Participants []CallParticipantResponse `json:"participants"`
TotalParticipants int32 `json:"total_participants"`
}
QueryCallParticipantsResponse defines model for QueryCallParticipantsResponse.
type QueryCallSessionParticipantStatsParams ¶
type QueryCallSessionParticipantStatsParams struct {
Sort *[]*SortParamRequest `form:"sort,omitempty" json:"sort,omitempty"`
FilterConditions *map[string]interface{} `form:"filter_conditions,omitempty" json:"filter_conditions,omitempty"`
Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
Prev *string `form:"prev,omitempty" json:"prev,omitempty"`
Next *string `form:"next,omitempty" json:"next,omitempty"`
}
QueryCallSessionParticipantStatsParams defines parameters for QueryCallSessionParticipantStats.
type QueryCallSessionParticipantStatsResponse ¶
type QueryCallSessionParticipantStatsResponse struct {
CallEndedAt *Time `json:"call_ended_at,omitempty"`
CallEvents *[]CallLevelEventPayload `json:"call_events,omitempty"`
CallID string `json:"call_id"`
CallSessionID string `json:"call_session_id"`
CallStartedAt *Time `json:"call_started_at,omitempty"`
CallType string `json:"call_type"`
Counts CallStatsParticipantCounts `json:"counts"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Next *string `json:"next,omitempty"`
Participants []CallStatsParticipant `json:"participants"`
Prev *string `json:"prev,omitempty"`
TmpDataSource *string `json:"tmp_data_source,omitempty"`
}
QueryCallSessionParticipantStatsResponse Basic response information
type QueryCallSessionParticipantStatsTimelineResponse ¶
type QueryCallSessionParticipantStatsTimelineResponse struct {
CallID string `json:"call_id"`
CallSessionID string `json:"call_session_id"`
CallType string `json:"call_type"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Events []CallParticipantTimeline `json:"events"`
UserID string `json:"user_id"`
UserSessionID string `json:"user_session_id"`
}
QueryCallSessionParticipantStatsTimelineResponse Basic response information
type QueryCallSessionStatsJSONRequestBody ¶
type QueryCallSessionStatsJSONRequestBody = QueryCallSessionStatsRequest
QueryCallSessionStatsJSONRequestBody defines body for QueryCallSessionStats for application/json ContentType.
type QueryCallSessionStatsRequest ¶
type QueryCallSessionStatsRequest struct {
// FilterConditions Filter conditions to apply to the query
FilterConditions *map[string]interface{} `json:"filter_conditions,omitempty"`
Limit *int32 `json:"limit,omitempty"`
Next *string `json:"next,omitempty"`
Prev *string `json:"prev,omitempty"`
// Sort Array of sort parameters
Sort *[]*SortParamRequest `json:"sort,omitempty"`
}
QueryCallSessionStatsRequest defines model for QueryCallSessionStatsRequest.
type QueryCallSessionStatsResponse ¶
type QueryCallSessionStatsResponse struct {
CallStats []CallStatsSessionResponse `json:"call_stats"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Next *string `json:"next,omitempty"`
Prev *string `json:"prev,omitempty"`
}
QueryCallSessionStatsResponse Basic response information
type QueryCallStatsJSONRequestBody ¶
type QueryCallStatsJSONRequestBody = QueryCallStatsRequest
QueryCallStatsJSONRequestBody defines body for QueryCallStats for application/json ContentType.
type QueryCallStatsMapResponse ¶
type QueryCallStatsMapResponse struct {
CallEndedAt *Time `json:"call_ended_at,omitempty"`
CallID string `json:"call_id"`
CallSessionID string `json:"call_session_id"`
CallStartedAt *Time `json:"call_started_at,omitempty"`
CallType string `json:"call_type"`
Counts CallStatsParticipantCounts `json:"counts"`
DataSource *string `json:"data_source,omitempty"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
EndTime *Time `json:"end_time,omitempty"`
GeneratedAt *Time `json:"generated_at,omitempty"`
Publishers *CallStatsMapPublishers `json:"publishers,omitempty"`
Sfus *CallStatsMapSFUs `json:"sfus,omitempty"`
StartTime *Time `json:"start_time,omitempty"`
Subscribers *CallStatsMapSubscribers `json:"subscribers,omitempty"`
}
QueryCallStatsMapResponse Basic response information
type QueryCallStatsRequest ¶
type QueryCallStatsRequest struct {
// FilterConditions Filter conditions to apply to the query
FilterConditions *map[string]interface{} `json:"filter_conditions,omitempty"`
Limit *int32 `json:"limit,omitempty"`
Next *string `json:"next,omitempty"`
Prev *string `json:"prev,omitempty"`
// Sort Array of sort parameters
Sort *[]*SortParamRequest `json:"sort,omitempty"`
}
QueryCallStatsRequest defines model for QueryCallStatsRequest.
type QueryCallStatsResponse ¶
type QueryCallStatsResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Next *string `json:"next,omitempty"`
Prev *string `json:"prev,omitempty"`
Reports []CallStatsReportSummaryResponse `json:"reports"`
}
QueryCallStatsResponse Basic response information
type QueryCallsJSONRequestBody ¶
type QueryCallsJSONRequestBody = QueryCallsRequest
QueryCallsJSONRequestBody defines body for QueryCalls for application/json ContentType.
type QueryCallsParams ¶
type QueryCallsParams struct {
ConnectionID *string `form:"connection_id,omitempty" json:"connection_id,omitempty"`
}
QueryCallsParams defines parameters for QueryCalls.
type QueryCallsRequest ¶
type QueryCallsRequest struct {
// FilterConditions Filter conditions to apply to the query
FilterConditions *map[string]interface{} `json:"filter_conditions,omitempty"`
Limit *int32 `json:"limit,omitempty"`
Next *string `json:"next,omitempty"`
Prev *string `json:"prev,omitempty"`
// Sort Array of sort parameters
Sort *[]*SortParamRequest `json:"sort,omitempty"`
Watch *bool `json:"watch,omitempty"`
}
QueryCallsRequest defines model for QueryCallsRequest.
type QueryCallsResponse ¶
type QueryCallsResponse struct {
Calls []CallStateResponseFields `json:"calls"`
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Next *string `json:"next,omitempty"`
Prev *string `json:"prev,omitempty"`
}
QueryCallsResponse defines model for QueryCallsResponse.
type RTMPBroadcastRequest ¶
type RTMPBroadcastRequest struct {
Layout *LayoutSettingsRequest `json:"layout,omitempty"`
// Name Name identifier for RTMP broadcast, must be unique in call
Name string `json:"name"`
// Quality If provided, will override the call's RTMP settings quality. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560
Quality *RTMPBroadcastRequestQuality `json:"quality,omitempty"`
// StreamKey If provided, will be appended at the end of stream_url
StreamKey *string `json:"stream_key,omitempty"`
// StreamURL URL for the RTMP server to send the call to
StreamURL string `json:"stream_url"`
}
RTMPBroadcastRequest RTMPBroadcastRequest is the payload for starting an RTMP broadcast.
type RTMPBroadcastRequestQuality ¶
type RTMPBroadcastRequestQuality string
RTMPBroadcastRequestQuality If provided, will override the call's RTMP settings quality. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560
const ( RTMPBroadcastRequestQualityN1080P RTMPBroadcastRequestQuality = "1080p" RTMPBroadcastRequestQualityN1440P RTMPBroadcastRequestQuality = "1440p" RTMPBroadcastRequestQualityN360P RTMPBroadcastRequestQuality = "360p" RTMPBroadcastRequestQualityN480P RTMPBroadcastRequestQuality = "480p" RTMPBroadcastRequestQualityN720P RTMPBroadcastRequestQuality = "720p" RTMPBroadcastRequestQualityPortrait1080X1920 RTMPBroadcastRequestQuality = "portrait-1080x1920" RTMPBroadcastRequestQualityPortrait1440X2560 RTMPBroadcastRequestQuality = "portrait-1440x2560" RTMPBroadcastRequestQualityPortrait360X640 RTMPBroadcastRequestQuality = "portrait-360x640" RTMPBroadcastRequestQualityPortrait480X854 RTMPBroadcastRequestQuality = "portrait-480x854" RTMPBroadcastRequestQualityPortrait720X1280 RTMPBroadcastRequestQuality = "portrait-720x1280" )
Defines values for RTMPBroadcastRequestQuality.
func (RTMPBroadcastRequestQuality) Valid ¶
func (e RTMPBroadcastRequestQuality) Valid() bool
Valid indicates whether the value is a known member of the RTMPBroadcastRequestQuality enum.
type RTMPIngress ¶
type RTMPIngress struct {
Address string `json:"address"`
}
RTMPIngress RTMP input settings
type RTMPSettingsRequest ¶
type RTMPSettingsRequest struct {
// Enabled Whether RTMP broadcasting is enabled
Enabled *bool `json:"enabled,omitempty"`
// Quality Resolution to set for the RTMP stream. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560
Quality *RTMPSettingsRequestQuality `json:"quality,omitempty"`
}
RTMPSettingsRequest defines model for RTMPSettingsRequest.
type RTMPSettingsRequestQuality ¶
type RTMPSettingsRequestQuality string
RTMPSettingsRequestQuality Resolution to set for the RTMP stream. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560
const ( RTMPSettingsRequestQualityN1080P RTMPSettingsRequestQuality = "1080p" RTMPSettingsRequestQualityN1440P RTMPSettingsRequestQuality = "1440p" RTMPSettingsRequestQualityN360P RTMPSettingsRequestQuality = "360p" RTMPSettingsRequestQualityN480P RTMPSettingsRequestQuality = "480p" RTMPSettingsRequestQualityN720P RTMPSettingsRequestQuality = "720p" RTMPSettingsRequestQualityPortrait1080X1920 RTMPSettingsRequestQuality = "portrait-1080x1920" RTMPSettingsRequestQualityPortrait1440X2560 RTMPSettingsRequestQuality = "portrait-1440x2560" RTMPSettingsRequestQualityPortrait360X640 RTMPSettingsRequestQuality = "portrait-360x640" RTMPSettingsRequestQualityPortrait480X854 RTMPSettingsRequestQuality = "portrait-480x854" RTMPSettingsRequestQualityPortrait720X1280 RTMPSettingsRequestQuality = "portrait-720x1280" )
Defines values for RTMPSettingsRequestQuality.
func (RTMPSettingsRequestQuality) Valid ¶
func (e RTMPSettingsRequestQuality) Valid() bool
Valid indicates whether the value is a known member of the RTMPSettingsRequestQuality enum.
type RTMPSettingsResponse ¶
RTMPSettingsResponse RTMPSettingsResponse is the payload for RTMP settings
type RawRecordingResponse ¶
type RawRecordingResponse struct {
Status string `json:"status"`
}
RawRecordingResponse defines model for RawRecordingResponse.
type RawRecordingSettingsRequest ¶
type RawRecordingSettingsRequest struct {
// AudioOnly If true, only audio tracks will be recorded
AudioOnly *bool `json:"audio_only,omitempty"`
// Mode Recording mode. One of: available, disabled, auto-on
Mode RawRecordingSettingsRequestMode `json:"mode"`
}
RawRecordingSettingsRequest defines model for RawRecordingSettingsRequest.
type RawRecordingSettingsRequestMode ¶
type RawRecordingSettingsRequestMode string
RawRecordingSettingsRequestMode Recording mode. One of: available, disabled, auto-on
const ( RawRecordingSettingsRequestModeAutoOn RawRecordingSettingsRequestMode = "auto-on" RawRecordingSettingsRequestModeAvailable RawRecordingSettingsRequestMode = "available" RawRecordingSettingsRequestModeDisabled RawRecordingSettingsRequestMode = "disabled" )
Defines values for RawRecordingSettingsRequestMode.
func (RawRecordingSettingsRequestMode) Valid ¶
func (e RawRecordingSettingsRequestMode) Valid() bool
Valid indicates whether the value is a known member of the RawRecordingSettingsRequestMode enum.
type RawRecordingSettingsResponse ¶
type RawRecordingSettingsResponse struct {
AudioOnly *bool `json:"audio_only,omitempty"`
Mode RawRecordingSettingsResponseMode `json:"mode"`
}
RawRecordingSettingsResponse defines model for RawRecordingSettingsResponse.
type RawRecordingSettingsResponseMode ¶
type RawRecordingSettingsResponseMode string
RawRecordingSettingsResponseMode defines model for RawRecordingSettingsResponse.Mode.
const ( RawRecordingSettingsResponseModeAutoOn RawRecordingSettingsResponseMode = "auto-on" RawRecordingSettingsResponseModeAvailable RawRecordingSettingsResponseMode = "available" RawRecordingSettingsResponseModeDisabled RawRecordingSettingsResponseMode = "disabled" )
Defines values for RawRecordingSettingsResponseMode.
func (RawRecordingSettingsResponseMode) Valid ¶
func (e RawRecordingSettingsResponseMode) Valid() bool
Valid indicates whether the value is a known member of the RawRecordingSettingsResponseMode enum.
type RecordSettingsRequest ¶
type RecordSettingsRequest struct {
// AudioOnly Whether to record audio only
AudioOnly *bool `json:"audio_only,omitempty"`
// Mode Recording mode. One of: available, disabled, auto-on
Mode RecordSettingsRequestMode `json:"mode"`
// Quality Recording quality. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560
Quality *RecordSettingsRequestQuality `json:"quality,omitempty"`
}
RecordSettingsRequest defines model for RecordSettingsRequest.
type RecordSettingsRequestMode ¶
type RecordSettingsRequestMode string
RecordSettingsRequestMode Recording mode. One of: available, disabled, auto-on
const ( RecordSettingsRequestModeAutoOn RecordSettingsRequestMode = "auto-on" RecordSettingsRequestModeAvailable RecordSettingsRequestMode = "available" RecordSettingsRequestModeDisabled RecordSettingsRequestMode = "disabled" )
Defines values for RecordSettingsRequestMode.
func (RecordSettingsRequestMode) Valid ¶
func (e RecordSettingsRequestMode) Valid() bool
Valid indicates whether the value is a known member of the RecordSettingsRequestMode enum.
type RecordSettingsRequestQuality ¶
type RecordSettingsRequestQuality string
RecordSettingsRequestQuality Recording quality. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560
const ( RecordSettingsRequestQualityN1080P RecordSettingsRequestQuality = "1080p" RecordSettingsRequestQualityN1440P RecordSettingsRequestQuality = "1440p" RecordSettingsRequestQualityN360P RecordSettingsRequestQuality = "360p" RecordSettingsRequestQualityN480P RecordSettingsRequestQuality = "480p" RecordSettingsRequestQualityN720P RecordSettingsRequestQuality = "720p" RecordSettingsRequestQualityPortrait1080X1920 RecordSettingsRequestQuality = "portrait-1080x1920" RecordSettingsRequestQualityPortrait1440X2560 RecordSettingsRequestQuality = "portrait-1440x2560" RecordSettingsRequestQualityPortrait360X640 RecordSettingsRequestQuality = "portrait-360x640" RecordSettingsRequestQualityPortrait480X854 RecordSettingsRequestQuality = "portrait-480x854" RecordSettingsRequestQualityPortrait720X1280 RecordSettingsRequestQuality = "portrait-720x1280" )
Defines values for RecordSettingsRequestQuality.
func (RecordSettingsRequestQuality) Valid ¶
func (e RecordSettingsRequestQuality) Valid() bool
Valid indicates whether the value is a known member of the RecordSettingsRequestQuality enum.
type RecordSettingsResponse ¶
type RecordSettingsResponse struct {
AudioOnly bool `json:"audio_only"`
Mode string `json:"mode"`
Quality string `json:"quality"`
}
RecordSettingsResponse RecordSettings is the payload for recording settings
type RejectCallJSONRequestBody ¶
type RejectCallJSONRequestBody = RejectCallRequest
RejectCallJSONRequestBody defines body for RejectCall for application/json ContentType.
type RejectCallRequest ¶
type RejectCallRequest struct {
// Reason Reason for rejecting the call
Reason *string `json:"reason,omitempty"`
}
RejectCallRequest defines model for RejectCallRequest.
type RejectCallResponse ¶
type RejectCallResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
RejectCallResponse defines model for RejectCallResponse.
type ReportByHistogramBucket ¶
type ReportByHistogramBucket struct {
Category string `json:"category"`
Count int32 `json:"count"`
LowerBound *Bound `json:"lower_bound,omitempty"`
Sum float64 `json:"sum"`
UpperBound *Bound `json:"upper_bound,omitempty"`
}
ReportByHistogramBucket defines model for ReportByHistogramBucket.
type ReportClientCallEventJSONRequestBody ¶
type ReportClientCallEventJSONRequestBody = ReportClientEventRequest
ReportClientCallEventJSONRequestBody defines body for ReportClientCallEvent for application/json ContentType.
type ReportClientEventRequest ¶
type ReportClientEventRequest struct {
// Events Client-side events to report (1-100 per request)
Events []ClientEvent `json:"events"`
}
ReportClientEventRequest Reports a batch of client-side telemetry events. Each event is validated and processed independently; one invalid event does not block the rest of the batch.
type ReportClientEventResponse ¶
type ReportClientEventResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
ReportClientEventResponse Response for reporting client-side telemetry events
type ReportResponse ¶
type ReportResponse struct {
Call CallReportResponse `json:"call"`
Participants ParticipantReportResponse `json:"participants"`
UserRatings UserRatingReportResponse `json:"user_ratings"`
}
ReportResponse defines model for ReportResponse.
type RequestPermissionJSONRequestBody ¶
type RequestPermissionJSONRequestBody = RequestPermissionRequest
RequestPermissionJSONRequestBody defines body for RequestPermission for application/json ContentType.
type RequestPermissionRequest ¶
type RequestPermissionRequest struct {
Permissions []RequestPermissionRequestPermissions `json:"permissions"`
}
RequestPermissionRequest defines model for RequestPermissionRequest.
type RequestPermissionRequestPermissions ¶
type RequestPermissionRequestPermissions string
RequestPermissionRequestPermissions defines model for RequestPermissionRequest.Permissions.
const ( RequestPermissionRequestPermissionsSendAudio RequestPermissionRequestPermissions = "send-audio" RequestPermissionRequestPermissionsSendVideo RequestPermissionRequestPermissions = "send-video" )
Defines values for RequestPermissionRequestPermissions.
func (RequestPermissionRequestPermissions) Valid ¶
func (e RequestPermissionRequestPermissions) Valid() bool
Valid indicates whether the value is a known member of the RequestPermissionRequestPermissions enum.
type RequestPermissionResponse ¶
type RequestPermissionResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
RequestPermissionResponse defines model for RequestPermissionResponse.
type ResolutionMetricsTimeSeries ¶
type ResolutionMetricsTimeSeries struct {
Height *MetricTimeSeries `json:"height,omitempty"`
Width *MetricTimeSeries `json:"width,omitempty"`
}
ResolutionMetricsTimeSeries defines model for ResolutionMetricsTimeSeries.
type ResolveSIPAuthJSONRequestBody ¶
type ResolveSIPAuthJSONRequestBody = ResolveSIPAuthRequest
ResolveSIPAuthJSONRequestBody defines body for ResolveSIPAuth for application/json ContentType.
type ResolveSIPAuthRequest ¶
type ResolveSIPAuthRequest struct {
// FromHost Host from the SIP From header
FromHost *string `json:"from_host,omitempty"`
// SIPCallerNumber SIP caller number
SIPCallerNumber string `json:"sip_caller_number"`
// SIPTrunkNumber SIP trunk number to look up
SIPTrunkNumber string `json:"sip_trunk_number"`
// SourceIP Transport-layer source IP address of the SIP request
SourceIP *string `json:"source_ip,omitempty"`
}
ResolveSIPAuthRequest Request to determine SIP trunk authentication requirements
type ResolveSIPAuthResponse ¶
type ResolveSIPAuthResponse struct {
// AuthResult Authentication result: password, accept, or no_trunk_found
AuthResult string `json:"auth_result"`
Duration string `json:"duration"`
// Password Password for digest authentication (when auth_result is password)
Password *string `json:"password,omitempty"`
// TrunkID ID of the matched SIP trunk
TrunkID *string `json:"trunk_id,omitempty"`
// Username Username for digest authentication (when auth_result is password)
Username *string `json:"username,omitempty"`
}
ResolveSIPAuthResponse Response containing the pre-authentication decision for a SIP trunk
type ResolveSIPInboundJSONRequestBody ¶
type ResolveSIPInboundJSONRequestBody = ResolveSIPInboundRequest
ResolveSIPInboundJSONRequestBody defines body for ResolveSIPInbound for application/json ContentType.
type ResolveSIPInboundRequest ¶
type ResolveSIPInboundRequest struct {
// Challenge SIP digest challenge authentication data
Challenge *SIPChallengeRequest `json:"challenge,omitempty"`
// RoutingNumber Optional routing number for routing number-based call routing (10 digits)
RoutingNumber *string `json:"routing_number,omitempty"`
// SIPCallerNumber SIP caller number
SIPCallerNumber string `json:"sip_caller_number"`
// SIPHeaders Optional SIP headers as key-value pairs
SIPHeaders *map[string]string `json:"sip_headers,omitempty"`
// SIPTrunkNumber SIP trunk number to resolve
SIPTrunkNumber string `json:"sip_trunk_number"`
// TrunkID Optional pre-authenticated trunk ID (from PreAuth no-auth flow)
TrunkID *string `json:"trunk_id,omitempty"`
}
ResolveSIPInboundRequest Request to resolve SIP inbound routing using challenge authentication
type ResolveSIPInboundResponse ¶
type ResolveSIPInboundResponse struct {
// Credentials Credentials for SIP inbound call authentication
Credentials SIPInboundCredentials `json:"credentials"`
Duration string `json:"duration"`
// SIPRoutingRule SIP Inbound Routing Rule response
SIPRoutingRule *SIPInboundRoutingRuleResponse `json:"sip_routing_rule,omitempty"`
// SIPTrunk SIP trunk information
SIPTrunk *SIPTrunkResponse `json:"sip_trunk,omitempty"`
}
ResolveSIPInboundResponse Response containing resolved SIP inbound routing information
type Response ¶
type Response struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
Response Basic response information
type RingCallJSONRequestBody ¶
type RingCallJSONRequestBody = RingCallRequest
RingCallJSONRequestBody defines body for RingCall for application/json ContentType.
type RingCallRequest ¶
type RingCallRequest struct {
// MembersIds Members that should receive the ring. If no ids are provided, all call members who are not already in the call will receive ring notifications.
MembersIds *[]string `json:"members_ids,omitempty"`
// Video Indicate if call should be video
Video *bool `json:"video,omitempty"`
}
RingCallRequest defines model for RingCallRequest.
type RingCallResponse ¶
type RingCallResponse struct {
Duration string `json:"duration"`
// MembersIds List of members ringing notification was sent to
MembersIds []string `json:"members_ids"`
}
RingCallResponse defines model for RingCallResponse.
type RingSettingsRequest ¶
type RingSettingsRequest struct {
// AutoCancelTimeoutMs When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs
AutoCancelTimeoutMs int32 `json:"auto_cancel_timeout_ms"`
// IncomingCallTimeoutMs When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs
IncomingCallTimeoutMs int32 `json:"incoming_call_timeout_ms"`
// MissedCallTimeoutMs When a callee doesn't accept or reject a ring call in this time a missed call event will be sent
MissedCallTimeoutMs *int32 `json:"missed_call_timeout_ms,omitempty"`
}
RingSettingsRequest defines model for RingSettingsRequest.
type RingSettingsResponse ¶
type RingSettingsResponse struct {
AutoCancelTimeoutMs int32 `json:"auto_cancel_timeout_ms"`
IncomingCallTimeoutMs int32 `json:"incoming_call_timeout_ms"`
MissedCallTimeoutMs int32 `json:"missed_call_timeout_ms"`
}
RingSettingsResponse defines model for RingSettingsResponse.
type SDKUsageReport ¶
type SDKUsageReport struct {
PerSdkUsage map[string]*PerSDKUsageReport `json:"per_sdk_usage"`
}
SDKUsageReport defines model for SDKUsageReport.
type SDKUsageReportResponse ¶
type SDKUsageReportResponse struct {
Daily []DailyAggregateSDKUsageReportResponse `json:"daily"`
}
SDKUsageReportResponse defines model for SDKUsageReportResponse.
type SFULocationResponse ¶
type SFULocationResponse struct {
// Coordinates Geographic coordinates
Coordinates CoordinatesResponse `json:"coordinates"`
Count *int32 `json:"count,omitempty"`
Datacenter string `json:"datacenter"`
ID string `json:"id"`
// Location Geographic location metadata
Location LocationResponse `json:"location"`
}
SFULocationResponse defines model for SFULocationResponse.
type SFUResponse ¶
type SFUResponse struct {
EdgeName string `json:"edge_name"`
URL string `json:"url"`
WsEndpoint string `json:"ws_endpoint"`
}
SFUResponse defines model for SFUResponse.
type SIPCallConfigsResponse ¶
type SIPCallConfigsResponse struct {
// CustomData Custom data associated with the call
CustomData map[string]interface{} `json:"custom_data"`
}
SIPCallConfigsResponse SIP call configuration response
type SIPCallerConfigsResponse ¶
type SIPCallerConfigsResponse struct {
// CustomData Custom data associated with the caller
CustomData map[string]interface{} `json:"custom_data"`
// ID Unique identifier for the caller
ID string `json:"id"`
}
SIPCallerConfigsResponse SIP caller configuration response
type SIPChallengeRequest ¶
type SIPChallengeRequest struct {
// A1 Deprecated: A1 hash for backward compatibility
A1 *string `json:"a1,omitempty"`
// Algorithm Hash algorithm (e.g., MD5, SHA-256)
Algorithm *string `json:"algorithm,omitempty"`
// Charset Character set
Charset *string `json:"charset,omitempty"`
// Cnonce Client nonce for qop=auth
Cnonce *string `json:"cnonce,omitempty"`
// Domain Domain list
Domain *[]string `json:"domain,omitempty"`
// Method SIP method (e.g., INVITE)
Method *string `json:"method,omitempty"`
// Nc Nonce count for qop=auth
Nc *string `json:"nc,omitempty"`
// Nonce Server nonce
Nonce *string `json:"nonce,omitempty"`
// Opaque Opaque value
Opaque *string `json:"opaque,omitempty"`
// Qop Quality of protection options
Qop *[]string `json:"qop,omitempty"`
// Realm Authentication realm
Realm *string `json:"realm,omitempty"`
// Response Digest response hash from client
Response *string `json:"response,omitempty"`
// Stale Whether the nonce is stale
Stale *bool `json:"stale,omitempty"`
// URI Request URI
URI *string `json:"uri,omitempty"`
// Userhash Whether to hash the username
Userhash *bool `json:"userhash,omitempty"`
// Username Username for authentication
Username *string `json:"username,omitempty"`
}
SIPChallengeRequest SIP digest challenge authentication data
type SIPDirectRoutingRuleCallConfigsResponse ¶
type SIPDirectRoutingRuleCallConfigsResponse struct {
// CallID ID of the call
CallID string `json:"call_id"`
// CallType Type of the call
CallType string `json:"call_type"`
}
SIPDirectRoutingRuleCallConfigsResponse Direct routing rule call configuration response
type SIPInboundCredentials ¶
type SIPInboundCredentials struct {
// APIKey API key for the application
APIKey string `json:"api_key"`
// CallCustomData Custom data associated with the call
CallCustomData map[string]interface{} `json:"call_custom_data"`
// CallID ID of the call
CallID string `json:"call_id"`
// CallType Type of the call
CallType string `json:"call_type"`
// Token Authentication token for the call
Token string `json:"token"`
// UserCustomData Custom data associated with the user
UserCustomData map[string]interface{} `json:"user_custom_data"`
// UserID User ID for the call
UserID string `json:"user_id"`
}
SIPInboundCredentials Credentials for SIP inbound call authentication
type SIPInboundRoutingRulePinConfigsResponse ¶
type SIPInboundRoutingRulePinConfigsResponse struct {
// CustomWebhookURL Optional webhook URL for custom PIN handling
CustomWebhookURL *string `json:"custom_webhook_url,omitempty"`
// PinFailedAttemptPrompt Prompt message for failed PIN attempts
PinFailedAttemptPrompt *string `json:"pin_failed_attempt_prompt,omitempty"`
// PinHangupPrompt Prompt message for hangup after PIN input
PinHangupPrompt *string `json:"pin_hangup_prompt,omitempty"`
// PinPrompt Prompt message for PIN input
PinPrompt *string `json:"pin_prompt,omitempty"`
// PinSuccessPrompt Prompt message for successful PIN input
PinSuccessPrompt *string `json:"pin_success_prompt,omitempty"`
}
SIPInboundRoutingRulePinConfigsResponse PIN routing rule call configuration response
type SIPInboundRoutingRuleResponse ¶
type SIPInboundRoutingRuleResponse struct {
// CallConfigs SIP call configuration response
CallConfigs *SIPCallConfigsResponse `json:"call_configs,omitempty"`
// CalledNumbers List of called numbers
CalledNumbers []string `json:"called_numbers"`
// CallerConfigs SIP caller configuration response
CallerConfigs *SIPCallerConfigsResponse `json:"caller_configs,omitempty"`
// CallerNumbers List of caller numbers
CallerNumbers *[]string `json:"caller_numbers,omitempty"`
// CreatedAt Creation timestamp
CreatedAt Time `json:"created_at"`
// DirectRoutingConfigs Direct routing rule call configuration response
DirectRoutingConfigs *SIPDirectRoutingRuleCallConfigsResponse `json:"direct_routing_configs,omitempty"`
Duration string `json:"duration"`
// ID Unique identifier of the SIP Inbound Routing Rule
ID string `json:"id"`
// Name Name of the SIP Inbound Routing Rule
Name string `json:"name"`
// PinProtectionConfigs PIN protection configuration response
PinProtectionConfigs *SIPPinProtectionConfigsResponse `json:"pin_protection_configs,omitempty"`
// PinRoutingConfigs PIN routing rule call configuration response
PinRoutingConfigs *SIPInboundRoutingRulePinConfigsResponse `json:"pin_routing_configs,omitempty"`
// TrunkIds List of SIP trunk IDs
TrunkIds []string `json:"trunk_ids"`
// UpdatedAt Last update timestamp
UpdatedAt Time `json:"updated_at"`
}
SIPInboundRoutingRuleResponse SIP Inbound Routing Rule response
type SIPPinProtectionConfigsResponse ¶
type SIPPinProtectionConfigsResponse struct {
// DefaultPin Default PIN to use if there is no PIN set on the call object
DefaultPin *string `json:"default_pin,omitempty"`
// Enabled Whether PIN protection is enabled
Enabled bool `json:"enabled"`
// MaxAttempts Maximum number of PIN attempts allowed
MaxAttempts *int32 `json:"max_attempts,omitempty"`
// RequiredPinDigits Number of digits required for the PIN
RequiredPinDigits *int32 `json:"required_pin_digits,omitempty"`
}
SIPPinProtectionConfigsResponse PIN protection configuration response
type SIPTrunkResponse ¶
type SIPTrunkResponse struct {
// AllowedIps Allowed IPv4/IPv6 addresses or CIDR blocks
AllowedIps []string `json:"allowed_ips"`
// CreatedAt Creation timestamp
CreatedAt Time `json:"created_at"`
// ID Unique identifier for the SIP trunk
ID string `json:"id"`
// Name Name of the SIP trunk
Name string `json:"name"`
// Numbers Phone numbers associated with this SIP trunk
Numbers []string `json:"numbers"`
// Password Password for SIP trunk authentication
Password string `json:"password"`
// UpdatedAt Last update timestamp
UpdatedAt Time `json:"updated_at"`
// URI The URI for the SIP trunk
URI string `json:"uri"`
// Username Username for SIP trunk authentication
Username string `json:"username"`
}
SIPTrunkResponse SIP trunk information
type SRTIngress ¶
type SRTIngress struct {
Address string `json:"address"`
}
SRTIngress defines model for SRTIngress.
type ScoreBands ¶
type ScoreBands struct {
Good *float64 `json:"good,omitempty"`
Ok *float64 `json:"ok,omitempty"`
Poor *float64 `json:"poor,omitempty"`
}
ScoreBands defines model for ScoreBands.
type ScreensharingSettingsRequest ¶
type ScreensharingSettingsRequest struct {
AccessRequestEnabled *bool `json:"access_request_enabled,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
TargetResolution *TargetResolution `json:"target_resolution,omitempty"`
}
ScreensharingSettingsRequest defines model for ScreensharingSettingsRequest.
type ScreensharingSettingsResponse ¶
type ScreensharingSettingsResponse struct {
AccessRequestEnabled bool `json:"access_request_enabled"`
Enabled bool `json:"enabled"`
TargetResolution *TargetResolution `json:"target_resolution,omitempty"`
}
ScreensharingSettingsResponse defines model for ScreensharingSettingsResponse.
type Segments ¶
type Segments struct {
ByBrowser []BroadcastSegment `json:"by_browser"`
ByCountry []BroadcastSegment `json:"by_country"`
ByCountryReason string `json:"by_country_reason"`
ByDeliveryZone []DeliveryZoneSegment `json:"by_delivery_zone"`
ByOs []BroadcastSegment `json:"by_os"`
BySdk []BroadcastSegment `json:"by_sdk"`
}
Segments defines model for Segments.
type SendCallEventJSONRequestBody ¶
type SendCallEventJSONRequestBody = SendCallEventRequest
SendCallEventJSONRequestBody defines body for SendCallEvent for application/json ContentType.
type SendCallEventRequest ¶
type SendCallEventRequest struct {
Custom *map[string]interface{} `json:"custom,omitempty"`
}
SendCallEventRequest Send a call event to the other user
type SendCallEventResponse ¶
type SendCallEventResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
SendCallEventResponse defines model for SendCallEventResponse.
type SendVideoReactionJSONRequestBody ¶
type SendVideoReactionJSONRequestBody = SendVideoReactionRequest
SendVideoReactionJSONRequestBody defines body for SendVideoReaction for application/json ContentType.
type SendVideoReactionRequest ¶
type SendVideoReactionRequest struct {
Custom *map[string]interface{} `json:"custom,omitempty"`
EmojiCode *string `json:"emoji_code,omitempty"`
Type string `json:"type"`
}
SendVideoReactionRequest defines model for SendVideoReactionRequest.
type SendVideoReactionResponse ¶
type SendVideoReactionResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Reaction VideoReactionResponse `json:"reaction"`
}
SendVideoReactionResponse Basic response information
type SessionClient ¶
type SessionClient struct {
IP *string `json:"ip,omitempty"`
Location *CallStatsLocation `json:"location,omitempty"`
Name *string `json:"name,omitempty"`
NetworkType *string `json:"network_type,omitempty"`
Version *string `json:"version,omitempty"`
}
SessionClient defines model for SessionClient.
type SessionSettingsRequest ¶
type SessionSettingsRequest struct {
InactivityTimeoutSeconds int32 `json:"inactivity_timeout_seconds"`
}
SessionSettingsRequest defines model for SessionSettingsRequest.
type SessionSettingsResponse ¶
type SessionSettingsResponse struct {
InactivityTimeoutSeconds int32 `json:"inactivity_timeout_seconds"`
}
SessionSettingsResponse defines model for SessionSettingsResponse.
type SessionWarningResponse ¶
type SessionWarningResponse struct {
Code string `json:"code"`
Time *Time `json:"time,omitempty"`
Warning string `json:"warning"`
}
SessionWarningResponse defines model for SessionWarningResponse.
type SortParamRequest ¶
type SortParamRequest struct {
// Direction Direction of sorting, 1 for Ascending, -1 for Descending, default is 1. One of: -1, 1
Direction *int32 `json:"direction,omitempty"`
// Field Name of field to sort by
Field *string `json:"field,omitempty"`
// Type Type of field to sort by. Empty string or omitted means string type (default). One of: number, boolean
Type *string `json:"type,omitempty"`
}
SortParamRequest defines model for SortParamRequest.
type SourceHealth ¶
type SourceHealth struct {
CoHostPeak int32 `json:"co_host_peak"`
DeadAirS int64 `json:"dead_air_s"`
Interruptions []SourceInterruption `json:"interruptions"`
PublisherSessions []*PublisherSession `json:"publisher_sessions"`
}
SourceHealth defines model for SourceHealth.
type SourceInterruption ¶
type SourceInterruption struct {
AtOffsetMin float64 `json:"at_offset_min"`
DeadAirS int64 `json:"dead_air_s"`
Kind string `json:"kind"`
Seamless *bool `json:"seamless,omitempty"`
}
SourceInterruption defines model for SourceInterruption.
type SpeechSegmentConfig ¶
type SpeechSegmentConfig struct {
MaxSpeechCaptionMs *int32 `json:"max_speech_caption_ms,omitempty"`
SilenceDurationMs *int32 `json:"silence_duration_ms,omitempty"`
}
SpeechSegmentConfig defines model for SpeechSegmentConfig.
type StartClosedCaptionsJSONRequestBody ¶
type StartClosedCaptionsJSONRequestBody = StartClosedCaptionsRequest
StartClosedCaptionsJSONRequestBody defines body for StartClosedCaptions for application/json ContentType.
type StartClosedCaptionsRequest ¶
type StartClosedCaptionsRequest struct {
// EnableTranscription Enable transcriptions along with closed captions
EnableTranscription *bool `json:"enable_transcription,omitempty"`
// ExternalStorage Which external storage to use for transcriptions (only applicable if enable_transcription is true)
ExternalStorage *string `json:"external_storage,omitempty"`
// Language The spoken language in the call, if not provided the language defined in the transcription settings will be used. One of: auto, ar, bg, ca, cs, da, de, el, en, es, et, fi, fr, he, hi, hr, hu, id, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sk, sl, sv, ta, th, tl, tr, uk, zh
Language *StartClosedCaptionsRequestLanguage `json:"language,omitempty"`
SpeechSegmentConfig *SpeechSegmentConfig `json:"speech_segment_config,omitempty"`
}
StartClosedCaptionsRequest defines model for StartClosedCaptionsRequest.
type StartClosedCaptionsRequestLanguage ¶
type StartClosedCaptionsRequestLanguage string
StartClosedCaptionsRequestLanguage The spoken language in the call, if not provided the language defined in the transcription settings will be used. One of: auto, ar, bg, ca, cs, da, de, el, en, es, et, fi, fr, he, hi, hr, hu, id, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sk, sl, sv, ta, th, tl, tr, uk, zh
const ( StartClosedCaptionsRequestLanguageAr StartClosedCaptionsRequestLanguage = "ar" StartClosedCaptionsRequestLanguageAuto StartClosedCaptionsRequestLanguage = "auto" StartClosedCaptionsRequestLanguageBg StartClosedCaptionsRequestLanguage = "bg" StartClosedCaptionsRequestLanguageCa StartClosedCaptionsRequestLanguage = "ca" StartClosedCaptionsRequestLanguageCs StartClosedCaptionsRequestLanguage = "cs" StartClosedCaptionsRequestLanguageDa StartClosedCaptionsRequestLanguage = "da" StartClosedCaptionsRequestLanguageDe StartClosedCaptionsRequestLanguage = "de" StartClosedCaptionsRequestLanguageEl StartClosedCaptionsRequestLanguage = "el" StartClosedCaptionsRequestLanguageEn StartClosedCaptionsRequestLanguage = "en" StartClosedCaptionsRequestLanguageEs StartClosedCaptionsRequestLanguage = "es" StartClosedCaptionsRequestLanguageEt StartClosedCaptionsRequestLanguage = "et" StartClosedCaptionsRequestLanguageFi StartClosedCaptionsRequestLanguage = "fi" StartClosedCaptionsRequestLanguageFr StartClosedCaptionsRequestLanguage = "fr" StartClosedCaptionsRequestLanguageHe StartClosedCaptionsRequestLanguage = "he" StartClosedCaptionsRequestLanguageHi StartClosedCaptionsRequestLanguage = "hi" StartClosedCaptionsRequestLanguageHr StartClosedCaptionsRequestLanguage = "hr" StartClosedCaptionsRequestLanguageHu StartClosedCaptionsRequestLanguage = "hu" StartClosedCaptionsRequestLanguageID StartClosedCaptionsRequestLanguage = "id" StartClosedCaptionsRequestLanguageIt StartClosedCaptionsRequestLanguage = "it" StartClosedCaptionsRequestLanguageJa StartClosedCaptionsRequestLanguage = "ja" StartClosedCaptionsRequestLanguageKo StartClosedCaptionsRequestLanguage = "ko" StartClosedCaptionsRequestLanguageMs StartClosedCaptionsRequestLanguage = "ms" StartClosedCaptionsRequestLanguageNl StartClosedCaptionsRequestLanguage = "nl" StartClosedCaptionsRequestLanguageNo StartClosedCaptionsRequestLanguage = "no" StartClosedCaptionsRequestLanguagePl StartClosedCaptionsRequestLanguage = "pl" StartClosedCaptionsRequestLanguagePt StartClosedCaptionsRequestLanguage = "pt" StartClosedCaptionsRequestLanguageRo StartClosedCaptionsRequestLanguage = "ro" StartClosedCaptionsRequestLanguageRu StartClosedCaptionsRequestLanguage = "ru" StartClosedCaptionsRequestLanguageSk StartClosedCaptionsRequestLanguage = "sk" StartClosedCaptionsRequestLanguageSl StartClosedCaptionsRequestLanguage = "sl" StartClosedCaptionsRequestLanguageSv StartClosedCaptionsRequestLanguage = "sv" StartClosedCaptionsRequestLanguageTa StartClosedCaptionsRequestLanguage = "ta" StartClosedCaptionsRequestLanguageTh StartClosedCaptionsRequestLanguage = "th" StartClosedCaptionsRequestLanguageTl StartClosedCaptionsRequestLanguage = "tl" StartClosedCaptionsRequestLanguageTr StartClosedCaptionsRequestLanguage = "tr" StartClosedCaptionsRequestLanguageUk StartClosedCaptionsRequestLanguage = "uk" StartClosedCaptionsRequestLanguageZh StartClosedCaptionsRequestLanguage = "zh" )
Defines values for StartClosedCaptionsRequestLanguage.
func (StartClosedCaptionsRequestLanguage) Valid ¶
func (e StartClosedCaptionsRequestLanguage) Valid() bool
Valid indicates whether the value is a known member of the StartClosedCaptionsRequestLanguage enum.
type StartClosedCaptionsResponse ¶
type StartClosedCaptionsResponse struct {
Duration string `json:"duration"`
}
StartClosedCaptionsResponse defines model for StartClosedCaptionsResponse.
type StartFrameRecordingJSONRequestBody ¶
type StartFrameRecordingJSONRequestBody = StartFrameRecordingRequest
StartFrameRecordingJSONRequestBody defines body for StartFrameRecording for application/json ContentType.
type StartFrameRecordingRequest ¶
type StartFrameRecordingRequest struct {
RecordingExternalStorage *string `json:"recording_external_storage,omitempty"`
}
StartFrameRecordingRequest defines model for StartFrameRecordingRequest.
type StartFrameRecordingResponse ¶
type StartFrameRecordingResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StartFrameRecordingResponse StartFrameRecordingResponse is the response payload for the start frame recording endpoint.
type StartHLSBroadcastingRequest ¶
type StartHLSBroadcastingRequest = map[string]interface{}
StartHLSBroadcastingRequest StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.
type StartHLSBroadcastingResponse ¶
type StartHLSBroadcastingResponse struct {
Duration string `json:"duration"`
// PlaylistURL the URL of the HLS playlist
PlaylistURL string `json:"playlist_url"`
}
StartHLSBroadcastingResponse StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.
type StartRTMPBroadcastsJSONRequestBody ¶
type StartRTMPBroadcastsJSONRequestBody = StartRTMPBroadcastsRequest
StartRTMPBroadcastsJSONRequestBody defines body for StartRTMPBroadcasts for application/json ContentType.
type StartRTMPBroadcastsRequest ¶
type StartRTMPBroadcastsRequest struct {
// Broadcasts List of broadcasts to start
Broadcasts []RTMPBroadcastRequest `json:"broadcasts"`
}
StartRTMPBroadcastsRequest StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.
type StartRTMPBroadcastsResponse ¶
type StartRTMPBroadcastsResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StartRTMPBroadcastsResponse StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.
type StartRecordingJSONRequestBody ¶
type StartRecordingJSONRequestBody = StartRecordingRequest
StartRecordingJSONRequestBody defines body for StartRecording for application/json ContentType.
type StartRecordingParamsRecordingType ¶
type StartRecordingParamsRecordingType string
StartRecordingParamsRecordingType defines parameters for StartRecording.
const ( StartRecordingParamsRecordingTypeComposite StartRecordingParamsRecordingType = "composite" StartRecordingParamsRecordingTypeIndividual StartRecordingParamsRecordingType = "individual" StartRecordingParamsRecordingTypeRaw StartRecordingParamsRecordingType = "raw" )
Defines values for StartRecordingParamsRecordingType.
func (StartRecordingParamsRecordingType) Valid ¶
func (e StartRecordingParamsRecordingType) Valid() bool
Valid indicates whether the value is a known member of the StartRecordingParamsRecordingType enum.
type StartRecordingRequest ¶
type StartRecordingRequest struct {
RecordingExternalStorage *string `json:"recording_external_storage,omitempty"`
}
StartRecordingRequest defines model for StartRecordingRequest.
type StartRecordingResponse ¶
type StartRecordingResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StartRecordingResponse StartRecordingResponse is the response payload for the start recording endpoint.
type StartTranscriptionJSONRequestBody ¶
type StartTranscriptionJSONRequestBody = StartTranscriptionRequest
StartTranscriptionJSONRequestBody defines body for StartTranscription for application/json ContentType.
type StartTranscriptionRequest ¶
type StartTranscriptionRequest struct {
// EnableClosedCaptions Enable closed captions along with transcriptions
EnableClosedCaptions *bool `json:"enable_closed_captions,omitempty"`
// Language The spoken language in the call, if not provided the language defined in the transcription settings will be used. One of: auto, ar, bg, ca, cs, da, de, el, en, es, et, fi, fr, he, hi, hr, hu, id, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sk, sl, sv, ta, th, tl, tr, uk, zh
Language *StartTranscriptionRequestLanguage `json:"language,omitempty"`
// TranscriptionExternalStorage Store transcriptions in this external storage
TranscriptionExternalStorage *string `json:"transcription_external_storage,omitempty"`
}
StartTranscriptionRequest defines model for StartTranscriptionRequest.
type StartTranscriptionRequestLanguage ¶
type StartTranscriptionRequestLanguage string
StartTranscriptionRequestLanguage The spoken language in the call, if not provided the language defined in the transcription settings will be used. One of: auto, ar, bg, ca, cs, da, de, el, en, es, et, fi, fr, he, hi, hr, hu, id, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sk, sl, sv, ta, th, tl, tr, uk, zh
const ( StartTranscriptionRequestLanguageAr StartTranscriptionRequestLanguage = "ar" StartTranscriptionRequestLanguageAuto StartTranscriptionRequestLanguage = "auto" StartTranscriptionRequestLanguageBg StartTranscriptionRequestLanguage = "bg" StartTranscriptionRequestLanguageCa StartTranscriptionRequestLanguage = "ca" StartTranscriptionRequestLanguageCs StartTranscriptionRequestLanguage = "cs" StartTranscriptionRequestLanguageDa StartTranscriptionRequestLanguage = "da" StartTranscriptionRequestLanguageDe StartTranscriptionRequestLanguage = "de" StartTranscriptionRequestLanguageEl StartTranscriptionRequestLanguage = "el" StartTranscriptionRequestLanguageEn StartTranscriptionRequestLanguage = "en" StartTranscriptionRequestLanguageEs StartTranscriptionRequestLanguage = "es" StartTranscriptionRequestLanguageEt StartTranscriptionRequestLanguage = "et" StartTranscriptionRequestLanguageFi StartTranscriptionRequestLanguage = "fi" StartTranscriptionRequestLanguageFr StartTranscriptionRequestLanguage = "fr" StartTranscriptionRequestLanguageHe StartTranscriptionRequestLanguage = "he" StartTranscriptionRequestLanguageHi StartTranscriptionRequestLanguage = "hi" StartTranscriptionRequestLanguageHr StartTranscriptionRequestLanguage = "hr" StartTranscriptionRequestLanguageHu StartTranscriptionRequestLanguage = "hu" StartTranscriptionRequestLanguageID StartTranscriptionRequestLanguage = "id" StartTranscriptionRequestLanguageIt StartTranscriptionRequestLanguage = "it" StartTranscriptionRequestLanguageJa StartTranscriptionRequestLanguage = "ja" StartTranscriptionRequestLanguageKo StartTranscriptionRequestLanguage = "ko" StartTranscriptionRequestLanguageMs StartTranscriptionRequestLanguage = "ms" StartTranscriptionRequestLanguageNl StartTranscriptionRequestLanguage = "nl" StartTranscriptionRequestLanguageNo StartTranscriptionRequestLanguage = "no" StartTranscriptionRequestLanguagePl StartTranscriptionRequestLanguage = "pl" StartTranscriptionRequestLanguagePt StartTranscriptionRequestLanguage = "pt" StartTranscriptionRequestLanguageRo StartTranscriptionRequestLanguage = "ro" StartTranscriptionRequestLanguageRu StartTranscriptionRequestLanguage = "ru" StartTranscriptionRequestLanguageSk StartTranscriptionRequestLanguage = "sk" StartTranscriptionRequestLanguageSl StartTranscriptionRequestLanguage = "sl" StartTranscriptionRequestLanguageSv StartTranscriptionRequestLanguage = "sv" StartTranscriptionRequestLanguageTa StartTranscriptionRequestLanguage = "ta" StartTranscriptionRequestLanguageTh StartTranscriptionRequestLanguage = "th" StartTranscriptionRequestLanguageTl StartTranscriptionRequestLanguage = "tl" StartTranscriptionRequestLanguageTr StartTranscriptionRequestLanguage = "tr" StartTranscriptionRequestLanguageUk StartTranscriptionRequestLanguage = "uk" StartTranscriptionRequestLanguageZh StartTranscriptionRequestLanguage = "zh" )
Defines values for StartTranscriptionRequestLanguage.
func (StartTranscriptionRequestLanguage) Valid ¶
func (e StartTranscriptionRequestLanguage) Valid() bool
Valid indicates whether the value is a known member of the StartTranscriptionRequestLanguage enum.
type StartTranscriptionResponse ¶
type StartTranscriptionResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StartTranscriptionResponse defines model for StartTranscriptionResponse.
type StatsOptions ¶
type StatsOptions struct {
EnableRtcStats bool `json:"enable_rtc_stats"`
ReportingIntervalMs int32 `json:"reporting_interval_ms"`
}
StatsOptions defines model for StatsOptions.
type StopAllRTMPBroadcastsRequest ¶
type StopAllRTMPBroadcastsRequest = map[string]interface{}
StopAllRTMPBroadcastsRequest defines model for StopAllRTMPBroadcastsRequest.
type StopAllRTMPBroadcastsResponse ¶
type StopAllRTMPBroadcastsResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StopAllRTMPBroadcastsResponse defines model for StopAllRTMPBroadcastsResponse.
type StopClosedCaptionsJSONRequestBody ¶
type StopClosedCaptionsJSONRequestBody = StopClosedCaptionsRequest
StopClosedCaptionsJSONRequestBody defines body for StopClosedCaptions for application/json ContentType.
type StopClosedCaptionsRequest ¶
type StopClosedCaptionsRequest struct {
StopTranscription *bool `json:"stop_transcription,omitempty"`
}
StopClosedCaptionsRequest defines model for StopClosedCaptionsRequest.
type StopClosedCaptionsResponse ¶
type StopClosedCaptionsResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StopClosedCaptionsResponse Basic response information
type StopFrameRecordingRequest ¶
type StopFrameRecordingRequest = map[string]interface{}
StopFrameRecordingRequest defines model for StopFrameRecordingRequest.
type StopFrameRecordingResponse ¶
type StopFrameRecordingResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StopFrameRecordingResponse Basic response information
type StopHLSBroadcastingRequest ¶
type StopHLSBroadcastingRequest = map[string]interface{}
StopHLSBroadcastingRequest defines model for StopHLSBroadcastingRequest.
type StopHLSBroadcastingResponse ¶
type StopHLSBroadcastingResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StopHLSBroadcastingResponse Basic response information
type StopLiveJSONRequestBody ¶
type StopLiveJSONRequestBody = StopLiveRequest
StopLiveJSONRequestBody defines body for StopLive for application/json ContentType.
type StopLiveRequest ¶
type StopLiveRequest struct {
ContinueClosedCaption *bool `json:"continue_closed_caption,omitempty"`
ContinueCompositeRecording *bool `json:"continue_composite_recording,omitempty"`
ContinueHls *bool `json:"continue_hls,omitempty"`
ContinueIndividualRecording *bool `json:"continue_individual_recording,omitempty"`
ContinueRawRecording *bool `json:"continue_raw_recording,omitempty"`
ContinueRecording *bool `json:"continue_recording,omitempty"`
ContinueRtmpBroadcasts *bool `json:"continue_rtmp_broadcasts,omitempty"`
ContinueTranscription *bool `json:"continue_transcription,omitempty"`
}
StopLiveRequest defines model for StopLiveRequest.
type StopLiveResponse ¶
type StopLiveResponse struct {
// Call Represents a call
Call CallResponse `json:"call"`
Duration string `json:"duration"`
}
StopLiveResponse defines model for StopLiveResponse.
type StopRTMPBroadcastJSONRequestBody ¶
type StopRTMPBroadcastJSONRequestBody = StopRTMPBroadcastsRequest
StopRTMPBroadcastJSONRequestBody defines body for StopRTMPBroadcast for application/json ContentType.
type StopRTMPBroadcastsRequest ¶
type StopRTMPBroadcastsRequest = map[string]interface{}
StopRTMPBroadcastsRequest Request for stopping RTMP broadcasts
type StopRTMPBroadcastsResponse ¶
type StopRTMPBroadcastsResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StopRTMPBroadcastsResponse Basic response information
type StopRecordingJSONRequestBody ¶
type StopRecordingJSONRequestBody = StopRecordingRequest
StopRecordingJSONRequestBody defines body for StopRecording for application/json ContentType.
type StopRecordingParamsRecordingType ¶
type StopRecordingParamsRecordingType string
StopRecordingParamsRecordingType defines parameters for StopRecording.
const ( StopRecordingParamsRecordingTypeComposite StopRecordingParamsRecordingType = "composite" StopRecordingParamsRecordingTypeIndividual StopRecordingParamsRecordingType = "individual" StopRecordingParamsRecordingTypeRaw StopRecordingParamsRecordingType = "raw" )
Defines values for StopRecordingParamsRecordingType.
func (StopRecordingParamsRecordingType) Valid ¶
func (e StopRecordingParamsRecordingType) Valid() bool
Valid indicates whether the value is a known member of the StopRecordingParamsRecordingType enum.
type StopRecordingRequest ¶
type StopRecordingRequest = map[string]interface{}
StopRecordingRequest defines model for StopRecordingRequest.
type StopRecordingResponse ¶
type StopRecordingResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StopRecordingResponse Basic response information
type StopTranscriptionJSONRequestBody ¶
type StopTranscriptionJSONRequestBody = StopTranscriptionRequest
StopTranscriptionJSONRequestBody defines body for StopTranscription for application/json ContentType.
type StopTranscriptionRequest ¶
type StopTranscriptionRequest struct {
StopClosedCaptions *bool `json:"stop_closed_captions,omitempty"`
}
StopTranscriptionRequest defines model for StopTranscriptionRequest.
type StopTranscriptionResponse ¶
type StopTranscriptionResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
StopTranscriptionResponse Basic response information
type SubscriberStatsResponse ¶
type SubscriberStatsResponse struct {
Total int32 `json:"total"`
TotalSubscribedDurationSeconds int32 `json:"total_subscribed_duration_seconds"`
Unique int32 `json:"unique"`
}
SubscriberStatsResponse defines model for SubscriberStatsResponse.
type Supporting ¶
type Supporting struct {
DeliveryIncidentWindows []Incident `json:"delivery_incident_windows"`
EdgeOutlierZones []string `json:"edge_outlier_zones"`
SourceDropWindows []TimeWindow `json:"source_drop_windows"`
}
Supporting defines model for Supporting.
type TargetResolution ¶
type TargetResolution struct {
Bitrate *int32 `json:"bitrate,omitempty"`
Height int32 `json:"height"`
Width int32 `json:"width"`
}
TargetResolution defines model for TargetResolution.
type ThumbnailResponse ¶
type ThumbnailResponse struct {
ImageURL string `json:"image_url"`
}
ThumbnailResponse defines model for ThumbnailResponse.
type ThumbnailsSettingsRequest ¶
type ThumbnailsSettingsRequest struct {
Enabled *bool `json:"enabled,omitempty"`
}
ThumbnailsSettingsRequest defines model for ThumbnailsSettingsRequest.
type ThumbnailsSettingsResponse ¶
type ThumbnailsSettingsResponse struct {
Enabled bool `json:"enabled"`
}
ThumbnailsSettingsResponse defines model for ThumbnailsSettingsResponse.
type Time ¶
Time is a coordinator timestamp.
The spec types these fields as date-time, but the coordinator answers with epoch nanoseconds ("created_at": 1786819855475907000), which time.Time rejects: its UnmarshalJSON accepts nothing but an RFC 3339 string. So every response carrying a timestamp failed to decode, which for /join meant a retry loop rather than a joined call.
Requests still go out as RFC 3339, which is what the coordinator accepts on the way in; that is the same asymmetry getstream-go's Timestamp settles on. Marshalling comes from the embedded time.Time, so only the reading half is spelled out here.
type TimeWindow ¶
TimeWindow defines model for TimeWindow.
type TrackStatsResponse ¶
type TrackStatsResponse struct {
DurationSeconds int32 `json:"duration_seconds"`
TrackType string `json:"track_type"`
}
TrackStatsResponse defines model for TrackStatsResponse.
type TranscriptionSettingsRequest ¶
type TranscriptionSettingsRequest struct {
ClosedCaptionMode *TranscriptionSettingsRequestClosedCaptionMode `json:"closed_caption_mode,omitempty"`
Language *TranscriptionSettingsRequestLanguage `json:"language,omitempty"`
Mode *TranscriptionSettingsRequestMode `json:"mode,omitempty"`
SpeechSegmentConfig *SpeechSegmentConfig `json:"speech_segment_config,omitempty"`
Translation *TranslationSettings `json:"translation,omitempty"`
}
TranscriptionSettingsRequest defines model for TranscriptionSettingsRequest.
type TranscriptionSettingsRequestClosedCaptionMode ¶
type TranscriptionSettingsRequestClosedCaptionMode string
TranscriptionSettingsRequestClosedCaptionMode defines model for TranscriptionSettingsRequest.ClosedCaptionMode.
const ( TranscriptionSettingsRequestClosedCaptionModeAutoOn TranscriptionSettingsRequestClosedCaptionMode = "auto-on" TranscriptionSettingsRequestClosedCaptionModeAvailable TranscriptionSettingsRequestClosedCaptionMode = "available" TranscriptionSettingsRequestClosedCaptionModeDisabled TranscriptionSettingsRequestClosedCaptionMode = "disabled" )
Defines values for TranscriptionSettingsRequestClosedCaptionMode.
func (TranscriptionSettingsRequestClosedCaptionMode) Valid ¶
func (e TranscriptionSettingsRequestClosedCaptionMode) Valid() bool
Valid indicates whether the value is a known member of the TranscriptionSettingsRequestClosedCaptionMode enum.
type TranscriptionSettingsRequestLanguage ¶
type TranscriptionSettingsRequestLanguage string
TranscriptionSettingsRequestLanguage defines model for TranscriptionSettingsRequest.Language.
const ( TranscriptionSettingsRequestLanguageAr TranscriptionSettingsRequestLanguage = "ar" TranscriptionSettingsRequestLanguageAuto TranscriptionSettingsRequestLanguage = "auto" TranscriptionSettingsRequestLanguageBg TranscriptionSettingsRequestLanguage = "bg" TranscriptionSettingsRequestLanguageCa TranscriptionSettingsRequestLanguage = "ca" TranscriptionSettingsRequestLanguageCs TranscriptionSettingsRequestLanguage = "cs" TranscriptionSettingsRequestLanguageDa TranscriptionSettingsRequestLanguage = "da" TranscriptionSettingsRequestLanguageDe TranscriptionSettingsRequestLanguage = "de" TranscriptionSettingsRequestLanguageEl TranscriptionSettingsRequestLanguage = "el" TranscriptionSettingsRequestLanguageEn TranscriptionSettingsRequestLanguage = "en" TranscriptionSettingsRequestLanguageEs TranscriptionSettingsRequestLanguage = "es" TranscriptionSettingsRequestLanguageEt TranscriptionSettingsRequestLanguage = "et" TranscriptionSettingsRequestLanguageFi TranscriptionSettingsRequestLanguage = "fi" TranscriptionSettingsRequestLanguageFr TranscriptionSettingsRequestLanguage = "fr" TranscriptionSettingsRequestLanguageHe TranscriptionSettingsRequestLanguage = "he" TranscriptionSettingsRequestLanguageHi TranscriptionSettingsRequestLanguage = "hi" TranscriptionSettingsRequestLanguageHr TranscriptionSettingsRequestLanguage = "hr" TranscriptionSettingsRequestLanguageHu TranscriptionSettingsRequestLanguage = "hu" TranscriptionSettingsRequestLanguageID TranscriptionSettingsRequestLanguage = "id" TranscriptionSettingsRequestLanguageIt TranscriptionSettingsRequestLanguage = "it" TranscriptionSettingsRequestLanguageJa TranscriptionSettingsRequestLanguage = "ja" TranscriptionSettingsRequestLanguageKo TranscriptionSettingsRequestLanguage = "ko" TranscriptionSettingsRequestLanguageMs TranscriptionSettingsRequestLanguage = "ms" TranscriptionSettingsRequestLanguageNl TranscriptionSettingsRequestLanguage = "nl" TranscriptionSettingsRequestLanguageNo TranscriptionSettingsRequestLanguage = "no" TranscriptionSettingsRequestLanguagePl TranscriptionSettingsRequestLanguage = "pl" TranscriptionSettingsRequestLanguagePt TranscriptionSettingsRequestLanguage = "pt" TranscriptionSettingsRequestLanguageRo TranscriptionSettingsRequestLanguage = "ro" TranscriptionSettingsRequestLanguageRu TranscriptionSettingsRequestLanguage = "ru" TranscriptionSettingsRequestLanguageSk TranscriptionSettingsRequestLanguage = "sk" TranscriptionSettingsRequestLanguageSl TranscriptionSettingsRequestLanguage = "sl" TranscriptionSettingsRequestLanguageSv TranscriptionSettingsRequestLanguage = "sv" TranscriptionSettingsRequestLanguageTa TranscriptionSettingsRequestLanguage = "ta" TranscriptionSettingsRequestLanguageTh TranscriptionSettingsRequestLanguage = "th" TranscriptionSettingsRequestLanguageTl TranscriptionSettingsRequestLanguage = "tl" TranscriptionSettingsRequestLanguageTr TranscriptionSettingsRequestLanguage = "tr" TranscriptionSettingsRequestLanguageUk TranscriptionSettingsRequestLanguage = "uk" TranscriptionSettingsRequestLanguageZh TranscriptionSettingsRequestLanguage = "zh" )
Defines values for TranscriptionSettingsRequestLanguage.
func (TranscriptionSettingsRequestLanguage) Valid ¶
func (e TranscriptionSettingsRequestLanguage) Valid() bool
Valid indicates whether the value is a known member of the TranscriptionSettingsRequestLanguage enum.
type TranscriptionSettingsRequestMode ¶
type TranscriptionSettingsRequestMode string
TranscriptionSettingsRequestMode defines model for TranscriptionSettingsRequest.Mode.
const ( TranscriptionSettingsRequestModeAutoOn TranscriptionSettingsRequestMode = "auto-on" TranscriptionSettingsRequestModeAvailable TranscriptionSettingsRequestMode = "available" TranscriptionSettingsRequestModeDisabled TranscriptionSettingsRequestMode = "disabled" )
Defines values for TranscriptionSettingsRequestMode.
func (TranscriptionSettingsRequestMode) Valid ¶
func (e TranscriptionSettingsRequestMode) Valid() bool
Valid indicates whether the value is a known member of the TranscriptionSettingsRequestMode enum.
type TranscriptionSettingsResponse ¶
type TranscriptionSettingsResponse struct {
ClosedCaptionMode TranscriptionSettingsResponseClosedCaptionMode `json:"closed_caption_mode"`
Language TranscriptionSettingsResponseLanguage `json:"language"`
Mode TranscriptionSettingsResponseMode `json:"mode"`
SpeechSegmentConfig *SpeechSegmentConfig `json:"speech_segment_config,omitempty"`
Translation *TranslationSettings `json:"translation,omitempty"`
}
TranscriptionSettingsResponse defines model for TranscriptionSettingsResponse.
type TranscriptionSettingsResponseClosedCaptionMode ¶
type TranscriptionSettingsResponseClosedCaptionMode string
TranscriptionSettingsResponseClosedCaptionMode defines model for TranscriptionSettingsResponse.ClosedCaptionMode.
const ( TranscriptionSettingsResponseClosedCaptionModeAutoOn TranscriptionSettingsResponseClosedCaptionMode = "auto-on" TranscriptionSettingsResponseClosedCaptionModeAvailable TranscriptionSettingsResponseClosedCaptionMode = "available" TranscriptionSettingsResponseClosedCaptionModeDisabled TranscriptionSettingsResponseClosedCaptionMode = "disabled" )
Defines values for TranscriptionSettingsResponseClosedCaptionMode.
func (TranscriptionSettingsResponseClosedCaptionMode) Valid ¶
func (e TranscriptionSettingsResponseClosedCaptionMode) Valid() bool
Valid indicates whether the value is a known member of the TranscriptionSettingsResponseClosedCaptionMode enum.
type TranscriptionSettingsResponseLanguage ¶
type TranscriptionSettingsResponseLanguage string
TranscriptionSettingsResponseLanguage defines model for TranscriptionSettingsResponse.Language.
const ( TranscriptionSettingsResponseLanguageAr TranscriptionSettingsResponseLanguage = "ar" TranscriptionSettingsResponseLanguageAuto TranscriptionSettingsResponseLanguage = "auto" TranscriptionSettingsResponseLanguageBg TranscriptionSettingsResponseLanguage = "bg" TranscriptionSettingsResponseLanguageCa TranscriptionSettingsResponseLanguage = "ca" TranscriptionSettingsResponseLanguageCs TranscriptionSettingsResponseLanguage = "cs" TranscriptionSettingsResponseLanguageDa TranscriptionSettingsResponseLanguage = "da" TranscriptionSettingsResponseLanguageDe TranscriptionSettingsResponseLanguage = "de" TranscriptionSettingsResponseLanguageEl TranscriptionSettingsResponseLanguage = "el" TranscriptionSettingsResponseLanguageEn TranscriptionSettingsResponseLanguage = "en" TranscriptionSettingsResponseLanguageEs TranscriptionSettingsResponseLanguage = "es" TranscriptionSettingsResponseLanguageEt TranscriptionSettingsResponseLanguage = "et" TranscriptionSettingsResponseLanguageFi TranscriptionSettingsResponseLanguage = "fi" TranscriptionSettingsResponseLanguageFr TranscriptionSettingsResponseLanguage = "fr" TranscriptionSettingsResponseLanguageHe TranscriptionSettingsResponseLanguage = "he" TranscriptionSettingsResponseLanguageHi TranscriptionSettingsResponseLanguage = "hi" TranscriptionSettingsResponseLanguageHr TranscriptionSettingsResponseLanguage = "hr" TranscriptionSettingsResponseLanguageHu TranscriptionSettingsResponseLanguage = "hu" TranscriptionSettingsResponseLanguageID TranscriptionSettingsResponseLanguage = "id" TranscriptionSettingsResponseLanguageIt TranscriptionSettingsResponseLanguage = "it" TranscriptionSettingsResponseLanguageJa TranscriptionSettingsResponseLanguage = "ja" TranscriptionSettingsResponseLanguageKo TranscriptionSettingsResponseLanguage = "ko" TranscriptionSettingsResponseLanguageMs TranscriptionSettingsResponseLanguage = "ms" TranscriptionSettingsResponseLanguageNl TranscriptionSettingsResponseLanguage = "nl" TranscriptionSettingsResponseLanguageNo TranscriptionSettingsResponseLanguage = "no" TranscriptionSettingsResponseLanguagePl TranscriptionSettingsResponseLanguage = "pl" TranscriptionSettingsResponseLanguagePt TranscriptionSettingsResponseLanguage = "pt" TranscriptionSettingsResponseLanguageRo TranscriptionSettingsResponseLanguage = "ro" TranscriptionSettingsResponseLanguageRu TranscriptionSettingsResponseLanguage = "ru" TranscriptionSettingsResponseLanguageSk TranscriptionSettingsResponseLanguage = "sk" TranscriptionSettingsResponseLanguageSl TranscriptionSettingsResponseLanguage = "sl" TranscriptionSettingsResponseLanguageSv TranscriptionSettingsResponseLanguage = "sv" TranscriptionSettingsResponseLanguageTa TranscriptionSettingsResponseLanguage = "ta" TranscriptionSettingsResponseLanguageTh TranscriptionSettingsResponseLanguage = "th" TranscriptionSettingsResponseLanguageTl TranscriptionSettingsResponseLanguage = "tl" TranscriptionSettingsResponseLanguageTr TranscriptionSettingsResponseLanguage = "tr" TranscriptionSettingsResponseLanguageUk TranscriptionSettingsResponseLanguage = "uk" TranscriptionSettingsResponseLanguageZh TranscriptionSettingsResponseLanguage = "zh" )
Defines values for TranscriptionSettingsResponseLanguage.
func (TranscriptionSettingsResponseLanguage) Valid ¶
func (e TranscriptionSettingsResponseLanguage) Valid() bool
Valid indicates whether the value is a known member of the TranscriptionSettingsResponseLanguage enum.
type TranscriptionSettingsResponseMode ¶
type TranscriptionSettingsResponseMode string
TranscriptionSettingsResponseMode defines model for TranscriptionSettingsResponse.Mode.
const ( TranscriptionSettingsResponseModeAutoOn TranscriptionSettingsResponseMode = "auto-on" TranscriptionSettingsResponseModeAvailable TranscriptionSettingsResponseMode = "available" TranscriptionSettingsResponseModeDisabled TranscriptionSettingsResponseMode = "disabled" )
Defines values for TranscriptionSettingsResponseMode.
func (TranscriptionSettingsResponseMode) Valid ¶
func (e TranscriptionSettingsResponseMode) Valid() bool
Valid indicates whether the value is a known member of the TranscriptionSettingsResponseMode enum.
type TranslationSettings ¶
type TranslationSettings struct {
Enabled *bool `json:"enabled,omitempty"`
Languages *[]TranslationSettingsLanguages `json:"languages,omitempty"`
}
TranslationSettings defines model for TranslationSettings.
type TranslationSettingsLanguages ¶
type TranslationSettingsLanguages string
TranslationSettingsLanguages defines model for TranslationSettings.Languages.
const ( TranslationSettingsLanguagesAr TranslationSettingsLanguages = "ar" TranslationSettingsLanguagesCa TranslationSettingsLanguages = "ca" TranslationSettingsLanguagesCs TranslationSettingsLanguages = "cs" TranslationSettingsLanguagesDa TranslationSettingsLanguages = "da" TranslationSettingsLanguagesDe TranslationSettingsLanguages = "de" TranslationSettingsLanguagesEl TranslationSettingsLanguages = "el" TranslationSettingsLanguagesEn TranslationSettingsLanguages = "en" TranslationSettingsLanguagesEs TranslationSettingsLanguages = "es" TranslationSettingsLanguagesFi TranslationSettingsLanguages = "fi" TranslationSettingsLanguagesFr TranslationSettingsLanguages = "fr" TranslationSettingsLanguagesHe TranslationSettingsLanguages = "he" TranslationSettingsLanguagesHi TranslationSettingsLanguages = "hi" TranslationSettingsLanguagesHr TranslationSettingsLanguages = "hr" TranslationSettingsLanguagesHu TranslationSettingsLanguages = "hu" TranslationSettingsLanguagesID TranslationSettingsLanguages = "id" TranslationSettingsLanguagesIt TranslationSettingsLanguages = "it" TranslationSettingsLanguagesJa TranslationSettingsLanguages = "ja" TranslationSettingsLanguagesKo TranslationSettingsLanguages = "ko" TranslationSettingsLanguagesMs TranslationSettingsLanguages = "ms" TranslationSettingsLanguagesNl TranslationSettingsLanguages = "nl" TranslationSettingsLanguagesNo TranslationSettingsLanguages = "no" TranslationSettingsLanguagesPl TranslationSettingsLanguages = "pl" TranslationSettingsLanguagesPt TranslationSettingsLanguages = "pt" TranslationSettingsLanguagesRo TranslationSettingsLanguages = "ro" TranslationSettingsLanguagesRu TranslationSettingsLanguages = "ru" TranslationSettingsLanguagesSv TranslationSettingsLanguages = "sv" TranslationSettingsLanguagesTa TranslationSettingsLanguages = "ta" TranslationSettingsLanguagesTh TranslationSettingsLanguages = "th" TranslationSettingsLanguagesTl TranslationSettingsLanguages = "tl" TranslationSettingsLanguagesTr TranslationSettingsLanguages = "tr" TranslationSettingsLanguagesUk TranslationSettingsLanguages = "uk" TranslationSettingsLanguagesZh TranslationSettingsLanguages = "zh" )
Defines values for TranslationSettingsLanguages.
func (TranslationSettingsLanguages) Valid ¶
func (e TranslationSettingsLanguages) Valid() bool
Valid indicates whether the value is a known member of the TranslationSettingsLanguages enum.
type UnblockUserJSONRequestBody ¶
type UnblockUserJSONRequestBody = UnblockUserRequest
UnblockUserJSONRequestBody defines body for UnblockUser for application/json ContentType.
type UnblockUserRequest ¶
type UnblockUserRequest struct {
// UserID the user to unblock
UserID string `json:"user_id"`
}
UnblockUserRequest UnblockUserRequest is the payload for unblocking a user.
type UnblockUserResponse ¶
type UnblockUserResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
UnblockUserResponse UnblockUserResponse is the payload for unblocking a user.
type UnblockedUserEvent ¶
type UnblockedUserEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// Type The type of event: "call.unblocked_user" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
UnblockedUserEvent This event is sent when a user is unblocked on a call, this can be useful to notify the user that they can now join the call again
func (UnblockedUserEvent) GetEventType ¶
func (UnblockedUserEvent) GetEventType() string
type UnpinRequest ¶
type UnpinRequest struct {
// SessionID the session ID of the user who pinned the message
SessionID string `json:"session_id"`
// UserID the user ID of the user who pinned the message
UserID string `json:"user_id"`
}
UnpinRequest UnpinRequest is the payload for unpinning a message.
type UnpinResponse ¶
type UnpinResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
UnpinResponse UnpinResponse is the payload for unpinning a message.
type UpdateCallJSONRequestBody ¶
type UpdateCallJSONRequestBody = UpdateCallRequest
UpdateCallJSONRequestBody defines body for UpdateCall for application/json ContentType.
type UpdateCallMembersJSONRequestBody ¶
type UpdateCallMembersJSONRequestBody = UpdateCallMembersRequest
UpdateCallMembersJSONRequestBody defines body for UpdateCallMembers for application/json ContentType.
type UpdateCallMembersRequest ¶
type UpdateCallMembersRequest struct {
// RemoveMembers List of userID to remove
RemoveMembers *[]string `json:"remove_members,omitempty"`
// UpdateMembers List of members to update or insert
UpdateMembers *[]MemberRequest `json:"update_members,omitempty"`
}
UpdateCallMembersRequest Update call members
type UpdateCallMembersResponse ¶
type UpdateCallMembersResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
Members []MemberResponse `json:"members"`
}
UpdateCallMembersResponse Basic response information
type UpdateCallRequest ¶
type UpdateCallRequest struct {
// Custom Custom data for this object
Custom *map[string]interface{} `json:"custom,omitempty"`
SettingsOverride *CallSettingsRequest `json:"settings_override,omitempty"`
// StartsAt the time the call is scheduled to start
StartsAt *Time `json:"starts_at,omitempty"`
}
UpdateCallRequest Request for updating a call
type UpdateCallResponse ¶
type UpdateCallResponse struct {
// Call Represents a call
Call CallResponse `json:"call"`
Duration string `json:"duration"`
Members []MemberResponse `json:"members"`
// Membership MemberResponse is the payload for a member of a call.
Membership *MemberResponse `json:"membership,omitempty"`
OwnCapabilities []OwnCapability `json:"own_capabilities"`
}
UpdateCallResponse Response for updating a call
type UpdateUserPermissionsJSONRequestBody ¶
type UpdateUserPermissionsJSONRequestBody = UpdateUserPermissionsRequest
UpdateUserPermissionsJSONRequestBody defines body for UpdateUserPermissions for application/json ContentType.
type UpdateUserPermissionsRequest ¶
type UpdateUserPermissionsRequest struct {
GrantPermissions *[]UpdateUserPermissionsRequestGrantPermissions `json:"grant_permissions,omitempty"`
RevokePermissions *[]UpdateUserPermissionsRequestRevokePermissions `json:"revoke_permissions,omitempty"`
UserID string `json:"user_id"`
}
UpdateUserPermissionsRequest defines model for UpdateUserPermissionsRequest.
type UpdateUserPermissionsRequestGrantPermissions ¶
type UpdateUserPermissionsRequestGrantPermissions string
UpdateUserPermissionsRequestGrantPermissions defines model for UpdateUserPermissionsRequest.GrantPermissions.
const ( UpdateUserPermissionsRequestGrantPermissionsSendAudio UpdateUserPermissionsRequestGrantPermissions = "send-audio" UpdateUserPermissionsRequestGrantPermissionsSendVideo UpdateUserPermissionsRequestGrantPermissions = "send-video" )
Defines values for UpdateUserPermissionsRequestGrantPermissions.
func (UpdateUserPermissionsRequestGrantPermissions) Valid ¶
func (e UpdateUserPermissionsRequestGrantPermissions) Valid() bool
Valid indicates whether the value is a known member of the UpdateUserPermissionsRequestGrantPermissions enum.
type UpdateUserPermissionsRequestRevokePermissions ¶
type UpdateUserPermissionsRequestRevokePermissions string
UpdateUserPermissionsRequestRevokePermissions defines model for UpdateUserPermissionsRequest.RevokePermissions.
const ( UpdateUserPermissionsRequestRevokePermissionsSendAudio UpdateUserPermissionsRequestRevokePermissions = "send-audio" UpdateUserPermissionsRequestRevokePermissionsSendVideo UpdateUserPermissionsRequestRevokePermissions = "send-video" )
Defines values for UpdateUserPermissionsRequestRevokePermissions.
func (UpdateUserPermissionsRequestRevokePermissions) Valid ¶
func (e UpdateUserPermissionsRequestRevokePermissions) Valid() bool
Valid indicates whether the value is a known member of the UpdateUserPermissionsRequestRevokePermissions enum.
type UpdateUserPermissionsResponse ¶
type UpdateUserPermissionsResponse struct {
// Duration Duration of the request in milliseconds
Duration string `json:"duration"`
}
UpdateUserPermissionsResponse Basic response information
type UpdatedCallPermissionsEvent ¶
type UpdatedCallPermissionsEvent struct {
CallCid string `json:"call_cid"`
CreatedAt Time `json:"created_at"`
// OwnCapabilities The capabilities of the current user
OwnCapabilities []OwnCapability `json:"own_capabilities"`
// Type The type of event: "call.permissions_updated" in this case
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
UpdatedCallPermissionsEvent This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly
func (UpdatedCallPermissionsEvent) GetEventType ¶
func (UpdatedCallPermissionsEvent) GetEventType() string
type UserBannedEvent ¶
type UserBannedEvent struct {
ChannelCustom *map[string]interface{} `json:"channel_custom,omitempty"`
// ChannelID The ID of the channel where the target user was banned
ChannelID *string `json:"channel_id,omitempty"`
ChannelMemberCount *int32 `json:"channel_member_count,omitempty"`
ChannelMessageCount *int64 `json:"channel_message_count,omitempty"`
// ChannelType The type of the channel where the target user was banned
ChannelType *string `json:"channel_type,omitempty"`
// Cid The CID of the channel where the target user was banned
Cid *string `json:"cid,omitempty"`
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
CreatedBy *UserResponseCommonFields `json:"created_by,omitempty"`
Custom map[string]interface{} `json:"custom"`
// Expiration The expiration date of the ban
Expiration *Time `json:"expiration,omitempty"`
// Reason The reason for the ban
Reason *string `json:"reason,omitempty"`
ReceivedAt *Time `json:"received_at,omitempty"`
// ReviewQueueItemID ID of the review queue item (flagged message) that triggered the ban, if the ban was applied from the moderation review queue
ReviewQueueItemID *string `json:"review_queue_item_id,omitempty"`
// Shadow Whether the user was shadow banned
Shadow *bool `json:"shadow,omitempty"`
// Team The team of the channel where the target user was banned
Team *string `json:"team,omitempty"`
TotalBans *int32 `json:"total_bans,omitempty"`
// Type The type of event: "user.banned" in this case
Type string `json:"type"`
User UserResponseCommonFields `json:"user"`
}
UserBannedEvent This event is sent when a user gets banned. The event contains information about the user that was banned.
func (UserBannedEvent) GetEventType ¶
func (UserBannedEvent) GetEventType() string
type UserDeactivatedEvent ¶
type UserDeactivatedEvent struct {
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
CreatedBy *UserResponseCommonFields `json:"created_by,omitempty"`
Custom map[string]interface{} `json:"custom"`
ReceivedAt *Time `json:"received_at,omitempty"`
// Type The type of event: "user.deactivated" in this case
Type string `json:"type"`
User UserResponseCommonFields `json:"user"`
}
UserDeactivatedEvent This event is sent when a user gets deactivated. The event contains information about the user that was deactivated.
func (UserDeactivatedEvent) GetEventType ¶
func (UserDeactivatedEvent) GetEventType() string
type UserDeletedEvent ¶
type UserDeletedEvent struct {
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
Custom map[string]interface{} `json:"custom"`
// DeleteConversation The type of deletion that was used for the user's conversations. One of: hard, soft, pruning, (empty string)
DeleteConversation string `json:"delete_conversation"`
// DeleteConversationChannels Whether the user's conversation channels were deleted
DeleteConversationChannels bool `json:"delete_conversation_channels"`
// DeleteMessages The type of deletion that was used for the user's messages. One of: hard, soft, pruning, (empty string)
DeleteMessages string `json:"delete_messages"`
// DeleteUser The type of deletion that was used for the user. One of: hard, soft, pruning, (empty string)
DeleteUser string `json:"delete_user"`
// HardDelete Whether the user was hard deleted
HardDelete bool `json:"hard_delete"`
// MarkMessagesDeleted Whether the user's messages were marked as deleted
MarkMessagesDeleted bool `json:"mark_messages_deleted"`
ReceivedAt *Time `json:"received_at,omitempty"`
// Type The type of event: "user.deleted" in this case
Type string `json:"type"`
User UserResponseCommonFields `json:"user"`
}
UserDeletedEvent This event is sent when a user gets deleted. The event contains information about the user that was deleted and the deletion options that were used.
func (UserDeletedEvent) GetEventType ¶
func (UserDeletedEvent) GetEventType() string
type UserFeedbackReport ¶
type UserFeedbackReport struct {
CountByRating map[string]int32 `json:"count_by_rating"`
UnreportedCount int32 `json:"unreported_count"`
}
UserFeedbackReport defines model for UserFeedbackReport.
type UserFeedbackReportResponse ¶
type UserFeedbackReportResponse struct {
Daily []DailyAggregateUserFeedbackReportResponse `json:"daily"`
}
UserFeedbackReportResponse defines model for UserFeedbackReportResponse.
type UserPresenceChangedEvent ¶
type UserPresenceChangedEvent struct {
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
Custom map[string]interface{} `json:"custom"`
ReceivedAt *Time `json:"received_at,omitempty"`
// Type The type of event: "user.presence.changed" in this case
Type string `json:"type"`
User UserResponseCommonFields `json:"user"`
}
UserPresenceChangedEvent This event is sent when the presence of a user changes. The event contains information about the user whose presence changed.
func (UserPresenceChangedEvent) GetEventType ¶
func (UserPresenceChangedEvent) GetEventType() string
type UserRatingReportResponse ¶
type UserRatingReportResponse struct {
Average float64 `json:"average"`
Count int32 `json:"count"`
}
UserRatingReportResponse defines model for UserRatingReportResponse.
type UserReactivatedEvent ¶
type UserReactivatedEvent struct {
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
CreatedBy *UserResponseCommonFields `json:"created_by,omitempty"`
Custom map[string]interface{} `json:"custom"`
ReceivedAt *Time `json:"received_at,omitempty"`
// Type The type of event: "user.reactivated" in this case
Type string `json:"type"`
User UserResponseCommonFields `json:"user"`
}
UserReactivatedEvent This event is sent when a user gets reactivated. The event contains information about the user that was reactivated.
func (UserReactivatedEvent) GetEventType ¶
func (UserReactivatedEvent) GetEventType() string
type UserRequest ¶
type UserRequest struct {
// Custom Custom user data
Custom *map[string]interface{} `json:"custom,omitempty"`
// ID User ID
ID string `json:"id"`
// Image User's profile image URL
Image *string `json:"image,omitempty"`
Invisible *bool `json:"invisible,omitempty"`
Language *string `json:"language,omitempty"`
// Name Optional name of user
Name *string `json:"name,omitempty"`
PrivacySettings *PrivacySettingsResponse `json:"privacy_settings,omitempty"`
}
UserRequest User request object
type UserResponse ¶
type UserResponse struct {
AvgResponseTime *int32 `json:"avg_response_time,omitempty"`
BlockedUserIds []string `json:"blocked_user_ids"`
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
// Custom Custom data for this object
Custom map[string]interface{} `json:"custom"`
// DeactivatedAt Date of deactivation
DeactivatedAt *Time `json:"deactivated_at,omitempty"`
// DeletedAt Date/time of deletion
DeletedAt *Time `json:"deleted_at,omitempty"`
// ID Unique user identifier
ID string `json:"id"`
Image *string `json:"image,omitempty"`
// Language Preferred language of a user
Language string `json:"language"`
// LastActive Date of last activity
LastActive *Time `json:"last_active,omitempty"`
// Name Optional name of user
Name *string `json:"name,omitempty"`
// RevokeTokensIssuedBefore Revocation date for tokens
RevokeTokensIssuedBefore *Time `json:"revoke_tokens_issued_before,omitempty"`
// Role Determines the set of user permissions
Role string `json:"role"`
// Teams List of teams user is a part of
Teams []string `json:"teams"`
TeamsRole *map[string]string `json:"teams_role,omitempty"`
// UpdatedAt Date/time of the last update
UpdatedAt Time `json:"updated_at"`
}
UserResponse User response object
type UserResponseCommonFields ¶
type UserResponseCommonFields struct {
AvgResponseTime *int32 `json:"avg_response_time,omitempty"`
BlockedUserIds []string `json:"blocked_user_ids"`
CreatedAt Time `json:"created_at"`
Custom map[string]interface{} `json:"custom"`
DeactivatedAt *Time `json:"deactivated_at,omitempty"`
DeletedAt *Time `json:"deleted_at,omitempty"`
ID string `json:"id"`
Image *string `json:"image,omitempty"`
Language string `json:"language"`
LastActive *Time `json:"last_active,omitempty"`
Name *string `json:"name,omitempty"`
RevokeTokensIssuedBefore *Time `json:"revoke_tokens_issued_before,omitempty"`
Role string `json:"role"`
Teams []string `json:"teams"`
TeamsRole *map[string]string `json:"teams_role,omitempty"`
UpdatedAt Time `json:"updated_at"`
}
UserResponseCommonFields defines model for UserResponseCommonFields.
type UserResponsePrivacyFields ¶
type UserResponsePrivacyFields struct {
AvgResponseTime *int32 `json:"avg_response_time,omitempty"`
BlockedUserIds []string `json:"blocked_user_ids"`
CreatedAt Time `json:"created_at"`
Custom map[string]interface{} `json:"custom"`
DeactivatedAt *Time `json:"deactivated_at,omitempty"`
DeletedAt *Time `json:"deleted_at,omitempty"`
ID string `json:"id"`
Image *string `json:"image,omitempty"`
Invisible *bool `json:"invisible,omitempty"`
Language string `json:"language"`
LastActive *Time `json:"last_active,omitempty"`
Name *string `json:"name,omitempty"`
PrivacySettings *PrivacySettingsResponse `json:"privacy_settings,omitempty"`
RevokeTokensIssuedBefore *Time `json:"revoke_tokens_issued_before,omitempty"`
Role string `json:"role"`
Teams []string `json:"teams"`
TeamsRole *map[string]string `json:"teams_role,omitempty"`
UpdatedAt Time `json:"updated_at"`
}
UserResponsePrivacyFields defines model for UserResponsePrivacyFields.
type UserUnbannedEvent ¶
type UserUnbannedEvent struct {
ChannelCustom *map[string]interface{} `json:"channel_custom,omitempty"`
// ChannelID The ID of the channel where the target user was unbanned
ChannelID *string `json:"channel_id,omitempty"`
ChannelMemberCount *int32 `json:"channel_member_count,omitempty"`
ChannelMessageCount *int64 `json:"channel_message_count,omitempty"`
// ChannelType The type of the channel where the target user was unbanned
ChannelType *string `json:"channel_type,omitempty"`
// Cid The CID of the channel where the target user was unbanned
Cid *string `json:"cid,omitempty"`
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
CreatedBy *UserResponseCommonFields `json:"created_by,omitempty"`
Custom map[string]interface{} `json:"custom"`
ReceivedAt *Time `json:"received_at,omitempty"`
// Shadow Whether the target user was shadow unbanned
Shadow *bool `json:"shadow,omitempty"`
// Team The team of the channel where the target user was unbanned
Team *string `json:"team,omitempty"`
// Type The type of event: "user.unbanned" in this case
Type string `json:"type"`
User UserResponseCommonFields `json:"user"`
}
UserUnbannedEvent This event is sent when a user gets unbanned. The event contains information about the user that was unbanned.
func (UserUnbannedEvent) GetEventType ¶
func (UserUnbannedEvent) GetEventType() string
type UserUpdatedEvent ¶
type UserUpdatedEvent struct {
// CreatedAt Date/time of creation
CreatedAt Time `json:"created_at"`
Custom map[string]interface{} `json:"custom"`
ReceivedAt *Time `json:"received_at,omitempty"`
// Type The type of event: "user.updated" in this case
Type string `json:"type"`
User UserResponsePrivacyFields `json:"user"`
}
UserUpdatedEvent This event is sent when a user gets updated. The event contains information about the updated user.
func (UserUpdatedEvent) GetEventType ¶
func (UserUpdatedEvent) GetEventType() string
type VideoEvent ¶
type VideoEvent struct {
// contains filtered or unexported fields
}
VideoEvent The discriminator object for all websocket events, it maps events' payload to the final type
func (VideoEvent) AsAppUpdatedEvent ¶
func (t VideoEvent) AsAppUpdatedEvent() (AppUpdatedEvent, error)
AsAppUpdatedEvent returns the union data inside the VideoEvent as a AppUpdatedEvent
func (VideoEvent) AsBlockedUserEvent ¶
func (t VideoEvent) AsBlockedUserEvent() (BlockedUserEvent, error)
AsBlockedUserEvent returns the union data inside the VideoEvent as a BlockedUserEvent
func (VideoEvent) AsCallAcceptedEvent ¶
func (t VideoEvent) AsCallAcceptedEvent() (CallAcceptedEvent, error)
AsCallAcceptedEvent returns the union data inside the VideoEvent as a CallAcceptedEvent
func (VideoEvent) AsCallClosedCaptionsFailedEvent ¶
func (t VideoEvent) AsCallClosedCaptionsFailedEvent() (CallClosedCaptionsFailedEvent, error)
AsCallClosedCaptionsFailedEvent returns the union data inside the VideoEvent as a CallClosedCaptionsFailedEvent
func (VideoEvent) AsCallClosedCaptionsStartedEvent ¶
func (t VideoEvent) AsCallClosedCaptionsStartedEvent() (CallClosedCaptionsStartedEvent, error)
AsCallClosedCaptionsStartedEvent returns the union data inside the VideoEvent as a CallClosedCaptionsStartedEvent
func (VideoEvent) AsCallClosedCaptionsStoppedEvent ¶
func (t VideoEvent) AsCallClosedCaptionsStoppedEvent() (CallClosedCaptionsStoppedEvent, error)
AsCallClosedCaptionsStoppedEvent returns the union data inside the VideoEvent as a CallClosedCaptionsStoppedEvent
func (VideoEvent) AsCallCreatedEvent ¶
func (t VideoEvent) AsCallCreatedEvent() (CallCreatedEvent, error)
AsCallCreatedEvent returns the union data inside the VideoEvent as a CallCreatedEvent
func (VideoEvent) AsCallDTMFEvent ¶
func (t VideoEvent) AsCallDTMFEvent() (CallDTMFEvent, error)
AsCallDTMFEvent returns the union data inside the VideoEvent as a CallDTMFEvent
func (VideoEvent) AsCallDeletedEvent ¶
func (t VideoEvent) AsCallDeletedEvent() (CallDeletedEvent, error)
AsCallDeletedEvent returns the union data inside the VideoEvent as a CallDeletedEvent
func (VideoEvent) AsCallEndedEvent ¶
func (t VideoEvent) AsCallEndedEvent() (CallEndedEvent, error)
AsCallEndedEvent returns the union data inside the VideoEvent as a CallEndedEvent
func (VideoEvent) AsCallFrameRecordingFailedEvent ¶
func (t VideoEvent) AsCallFrameRecordingFailedEvent() (CallFrameRecordingFailedEvent, error)
AsCallFrameRecordingFailedEvent returns the union data inside the VideoEvent as a CallFrameRecordingFailedEvent
func (VideoEvent) AsCallFrameRecordingFrameReadyEvent ¶
func (t VideoEvent) AsCallFrameRecordingFrameReadyEvent() (CallFrameRecordingFrameReadyEvent, error)
AsCallFrameRecordingFrameReadyEvent returns the union data inside the VideoEvent as a CallFrameRecordingFrameReadyEvent
func (VideoEvent) AsCallFrameRecordingStartedEvent ¶
func (t VideoEvent) AsCallFrameRecordingStartedEvent() (CallFrameRecordingStartedEvent, error)
AsCallFrameRecordingStartedEvent returns the union data inside the VideoEvent as a CallFrameRecordingStartedEvent
func (VideoEvent) AsCallFrameRecordingStoppedEvent ¶
func (t VideoEvent) AsCallFrameRecordingStoppedEvent() (CallFrameRecordingStoppedEvent, error)
AsCallFrameRecordingStoppedEvent returns the union data inside the VideoEvent as a CallFrameRecordingStoppedEvent
func (VideoEvent) AsCallHLSBroadcastingFailedEvent ¶
func (t VideoEvent) AsCallHLSBroadcastingFailedEvent() (CallHLSBroadcastingFailedEvent, error)
AsCallHLSBroadcastingFailedEvent returns the union data inside the VideoEvent as a CallHLSBroadcastingFailedEvent
func (VideoEvent) AsCallHLSBroadcastingStartedEvent ¶
func (t VideoEvent) AsCallHLSBroadcastingStartedEvent() (CallHLSBroadcastingStartedEvent, error)
AsCallHLSBroadcastingStartedEvent returns the union data inside the VideoEvent as a CallHLSBroadcastingStartedEvent
func (VideoEvent) AsCallHLSBroadcastingStoppedEvent ¶
func (t VideoEvent) AsCallHLSBroadcastingStoppedEvent() (CallHLSBroadcastingStoppedEvent, error)
AsCallHLSBroadcastingStoppedEvent returns the union data inside the VideoEvent as a CallHLSBroadcastingStoppedEvent
func (VideoEvent) AsCallLiveStartedEvent ¶
func (t VideoEvent) AsCallLiveStartedEvent() (CallLiveStartedEvent, error)
AsCallLiveStartedEvent returns the union data inside the VideoEvent as a CallLiveStartedEvent
func (VideoEvent) AsCallMemberAddedEvent ¶
func (t VideoEvent) AsCallMemberAddedEvent() (CallMemberAddedEvent, error)
AsCallMemberAddedEvent returns the union data inside the VideoEvent as a CallMemberAddedEvent
func (VideoEvent) AsCallMemberRemovedEvent ¶
func (t VideoEvent) AsCallMemberRemovedEvent() (CallMemberRemovedEvent, error)
AsCallMemberRemovedEvent returns the union data inside the VideoEvent as a CallMemberRemovedEvent
func (VideoEvent) AsCallMemberUpdatedEvent ¶
func (t VideoEvent) AsCallMemberUpdatedEvent() (CallMemberUpdatedEvent, error)
AsCallMemberUpdatedEvent returns the union data inside the VideoEvent as a CallMemberUpdatedEvent
func (VideoEvent) AsCallMemberUpdatedPermissionEvent ¶
func (t VideoEvent) AsCallMemberUpdatedPermissionEvent() (CallMemberUpdatedPermissionEvent, error)
AsCallMemberUpdatedPermissionEvent returns the union data inside the VideoEvent as a CallMemberUpdatedPermissionEvent
func (VideoEvent) AsCallMissedEvent ¶
func (t VideoEvent) AsCallMissedEvent() (CallMissedEvent, error)
AsCallMissedEvent returns the union data inside the VideoEvent as a CallMissedEvent
func (VideoEvent) AsCallModerationBlurEvent ¶
func (t VideoEvent) AsCallModerationBlurEvent() (CallModerationBlurEvent, error)
AsCallModerationBlurEvent returns the union data inside the VideoEvent as a CallModerationBlurEvent
func (VideoEvent) AsCallModerationWarningEvent ¶
func (t VideoEvent) AsCallModerationWarningEvent() (CallModerationWarningEvent, error)
AsCallModerationWarningEvent returns the union data inside the VideoEvent as a CallModerationWarningEvent
func (VideoEvent) AsCallNotificationEvent ¶
func (t VideoEvent) AsCallNotificationEvent() (CallNotificationEvent, error)
AsCallNotificationEvent returns the union data inside the VideoEvent as a CallNotificationEvent
func (VideoEvent) AsCallReactionEvent ¶
func (t VideoEvent) AsCallReactionEvent() (CallReactionEvent, error)
AsCallReactionEvent returns the union data inside the VideoEvent as a CallReactionEvent
func (VideoEvent) AsCallRecordingFailedEvent ¶
func (t VideoEvent) AsCallRecordingFailedEvent() (CallRecordingFailedEvent, error)
AsCallRecordingFailedEvent returns the union data inside the VideoEvent as a CallRecordingFailedEvent
func (VideoEvent) AsCallRecordingReadyEvent ¶
func (t VideoEvent) AsCallRecordingReadyEvent() (CallRecordingReadyEvent, error)
AsCallRecordingReadyEvent returns the union data inside the VideoEvent as a CallRecordingReadyEvent
func (VideoEvent) AsCallRecordingStartedEvent ¶
func (t VideoEvent) AsCallRecordingStartedEvent() (CallRecordingStartedEvent, error)
AsCallRecordingStartedEvent returns the union data inside the VideoEvent as a CallRecordingStartedEvent
func (VideoEvent) AsCallRecordingStoppedEvent ¶
func (t VideoEvent) AsCallRecordingStoppedEvent() (CallRecordingStoppedEvent, error)
AsCallRecordingStoppedEvent returns the union data inside the VideoEvent as a CallRecordingStoppedEvent
func (VideoEvent) AsCallRejectedEvent ¶
func (t VideoEvent) AsCallRejectedEvent() (CallRejectedEvent, error)
AsCallRejectedEvent returns the union data inside the VideoEvent as a CallRejectedEvent
func (VideoEvent) AsCallRingEvent ¶
func (t VideoEvent) AsCallRingEvent() (CallRingEvent, error)
AsCallRingEvent returns the union data inside the VideoEvent as a CallRingEvent
func (VideoEvent) AsCallRtmpBroadcastFailedEvent ¶
func (t VideoEvent) AsCallRtmpBroadcastFailedEvent() (CallRtmpBroadcastFailedEvent, error)
AsCallRtmpBroadcastFailedEvent returns the union data inside the VideoEvent as a CallRtmpBroadcastFailedEvent
func (VideoEvent) AsCallRtmpBroadcastStartedEvent ¶
func (t VideoEvent) AsCallRtmpBroadcastStartedEvent() (CallRtmpBroadcastStartedEvent, error)
AsCallRtmpBroadcastStartedEvent returns the union data inside the VideoEvent as a CallRtmpBroadcastStartedEvent
func (VideoEvent) AsCallRtmpBroadcastStoppedEvent ¶
func (t VideoEvent) AsCallRtmpBroadcastStoppedEvent() (CallRtmpBroadcastStoppedEvent, error)
AsCallRtmpBroadcastStoppedEvent returns the union data inside the VideoEvent as a CallRtmpBroadcastStoppedEvent
func (VideoEvent) AsCallSessionEndedEvent ¶
func (t VideoEvent) AsCallSessionEndedEvent() (CallSessionEndedEvent, error)
AsCallSessionEndedEvent returns the union data inside the VideoEvent as a CallSessionEndedEvent
func (VideoEvent) AsCallSessionParticipantCountsUpdatedEvent ¶
func (t VideoEvent) AsCallSessionParticipantCountsUpdatedEvent() (CallSessionParticipantCountsUpdatedEvent, error)
AsCallSessionParticipantCountsUpdatedEvent returns the union data inside the VideoEvent as a CallSessionParticipantCountsUpdatedEvent
func (VideoEvent) AsCallSessionParticipantJoinedEvent ¶
func (t VideoEvent) AsCallSessionParticipantJoinedEvent() (CallSessionParticipantJoinedEvent, error)
AsCallSessionParticipantJoinedEvent returns the union data inside the VideoEvent as a CallSessionParticipantJoinedEvent
func (VideoEvent) AsCallSessionParticipantLeftEvent ¶
func (t VideoEvent) AsCallSessionParticipantLeftEvent() (CallSessionParticipantLeftEvent, error)
AsCallSessionParticipantLeftEvent returns the union data inside the VideoEvent as a CallSessionParticipantLeftEvent
func (VideoEvent) AsCallSessionStartedEvent ¶
func (t VideoEvent) AsCallSessionStartedEvent() (CallSessionStartedEvent, error)
AsCallSessionStartedEvent returns the union data inside the VideoEvent as a CallSessionStartedEvent
func (VideoEvent) AsCallStatsReportReadyEvent ¶
func (t VideoEvent) AsCallStatsReportReadyEvent() (CallStatsReportReadyEvent, error)
AsCallStatsReportReadyEvent returns the union data inside the VideoEvent as a CallStatsReportReadyEvent
func (VideoEvent) AsCallTranscriptionFailedEvent ¶
func (t VideoEvent) AsCallTranscriptionFailedEvent() (CallTranscriptionFailedEvent, error)
AsCallTranscriptionFailedEvent returns the union data inside the VideoEvent as a CallTranscriptionFailedEvent
func (VideoEvent) AsCallTranscriptionReadyEvent ¶
func (t VideoEvent) AsCallTranscriptionReadyEvent() (CallTranscriptionReadyEvent, error)
AsCallTranscriptionReadyEvent returns the union data inside the VideoEvent as a CallTranscriptionReadyEvent
func (VideoEvent) AsCallTranscriptionStartedEvent ¶
func (t VideoEvent) AsCallTranscriptionStartedEvent() (CallTranscriptionStartedEvent, error)
AsCallTranscriptionStartedEvent returns the union data inside the VideoEvent as a CallTranscriptionStartedEvent
func (VideoEvent) AsCallTranscriptionStoppedEvent ¶
func (t VideoEvent) AsCallTranscriptionStoppedEvent() (CallTranscriptionStoppedEvent, error)
AsCallTranscriptionStoppedEvent returns the union data inside the VideoEvent as a CallTranscriptionStoppedEvent
func (VideoEvent) AsCallUpdatedEvent ¶
func (t VideoEvent) AsCallUpdatedEvent() (CallUpdatedEvent, error)
AsCallUpdatedEvent returns the union data inside the VideoEvent as a CallUpdatedEvent
func (VideoEvent) AsCallUserFeedbackSubmittedEvent ¶
func (t VideoEvent) AsCallUserFeedbackSubmittedEvent() (CallUserFeedbackSubmittedEvent, error)
AsCallUserFeedbackSubmittedEvent returns the union data inside the VideoEvent as a CallUserFeedbackSubmittedEvent
func (VideoEvent) AsCallUserMutedEvent ¶
func (t VideoEvent) AsCallUserMutedEvent() (CallUserMutedEvent, error)
AsCallUserMutedEvent returns the union data inside the VideoEvent as a CallUserMutedEvent
func (VideoEvent) AsClosedCaptionEvent ¶
func (t VideoEvent) AsClosedCaptionEvent() (ClosedCaptionEvent, error)
AsClosedCaptionEvent returns the union data inside the VideoEvent as a ClosedCaptionEvent
func (VideoEvent) AsConnectedEvent ¶
func (t VideoEvent) AsConnectedEvent() (ConnectedEvent, error)
AsConnectedEvent returns the union data inside the VideoEvent as a ConnectedEvent
func (VideoEvent) AsConnectionErrorEvent ¶
func (t VideoEvent) AsConnectionErrorEvent() (ConnectionErrorEvent, error)
AsConnectionErrorEvent returns the union data inside the VideoEvent as a ConnectionErrorEvent
func (VideoEvent) AsCustomVideoEvent ¶
func (t VideoEvent) AsCustomVideoEvent() (CustomVideoEvent, error)
AsCustomVideoEvent returns the union data inside the VideoEvent as a CustomVideoEvent
func (VideoEvent) AsHealthCheckEvent ¶
func (t VideoEvent) AsHealthCheckEvent() (HealthCheckEvent, error)
AsHealthCheckEvent returns the union data inside the VideoEvent as a HealthCheckEvent
func (VideoEvent) AsIngressErrorEvent ¶
func (t VideoEvent) AsIngressErrorEvent() (IngressErrorEvent, error)
AsIngressErrorEvent returns the union data inside the VideoEvent as a IngressErrorEvent
func (VideoEvent) AsIngressStartedEvent ¶
func (t VideoEvent) AsIngressStartedEvent() (IngressStartedEvent, error)
AsIngressStartedEvent returns the union data inside the VideoEvent as a IngressStartedEvent
func (VideoEvent) AsIngressStoppedEvent ¶
func (t VideoEvent) AsIngressStoppedEvent() (IngressStoppedEvent, error)
AsIngressStoppedEvent returns the union data inside the VideoEvent as a IngressStoppedEvent
func (VideoEvent) AsKickedUserEvent ¶
func (t VideoEvent) AsKickedUserEvent() (KickedUserEvent, error)
AsKickedUserEvent returns the union data inside the VideoEvent as a KickedUserEvent
func (VideoEvent) AsPermissionRequestEvent ¶
func (t VideoEvent) AsPermissionRequestEvent() (PermissionRequestEvent, error)
AsPermissionRequestEvent returns the union data inside the VideoEvent as a PermissionRequestEvent
func (VideoEvent) AsUnblockedUserEvent ¶
func (t VideoEvent) AsUnblockedUserEvent() (UnblockedUserEvent, error)
AsUnblockedUserEvent returns the union data inside the VideoEvent as a UnblockedUserEvent
func (VideoEvent) AsUpdatedCallPermissionsEvent ¶
func (t VideoEvent) AsUpdatedCallPermissionsEvent() (UpdatedCallPermissionsEvent, error)
AsUpdatedCallPermissionsEvent returns the union data inside the VideoEvent as a UpdatedCallPermissionsEvent
func (VideoEvent) AsUserBannedEvent ¶
func (t VideoEvent) AsUserBannedEvent() (UserBannedEvent, error)
AsUserBannedEvent returns the union data inside the VideoEvent as a UserBannedEvent
func (VideoEvent) AsUserDeactivatedEvent ¶
func (t VideoEvent) AsUserDeactivatedEvent() (UserDeactivatedEvent, error)
AsUserDeactivatedEvent returns the union data inside the VideoEvent as a UserDeactivatedEvent
func (VideoEvent) AsUserDeletedEvent ¶
func (t VideoEvent) AsUserDeletedEvent() (UserDeletedEvent, error)
AsUserDeletedEvent returns the union data inside the VideoEvent as a UserDeletedEvent
func (VideoEvent) AsUserPresenceChangedEvent ¶
func (t VideoEvent) AsUserPresenceChangedEvent() (UserPresenceChangedEvent, error)
AsUserPresenceChangedEvent returns the union data inside the VideoEvent as a UserPresenceChangedEvent
func (VideoEvent) AsUserReactivatedEvent ¶
func (t VideoEvent) AsUserReactivatedEvent() (UserReactivatedEvent, error)
AsUserReactivatedEvent returns the union data inside the VideoEvent as a UserReactivatedEvent
func (VideoEvent) AsUserUnbannedEvent ¶
func (t VideoEvent) AsUserUnbannedEvent() (UserUnbannedEvent, error)
AsUserUnbannedEvent returns the union data inside the VideoEvent as a UserUnbannedEvent
func (VideoEvent) AsUserUpdatedEvent ¶
func (t VideoEvent) AsUserUpdatedEvent() (UserUpdatedEvent, error)
AsUserUpdatedEvent returns the union data inside the VideoEvent as a UserUpdatedEvent
func (VideoEvent) Discriminator ¶
func (t VideoEvent) Discriminator() (string, error)
func (*VideoEvent) FromAppUpdatedEvent ¶
func (t *VideoEvent) FromAppUpdatedEvent(v AppUpdatedEvent) error
FromAppUpdatedEvent overwrites any union data inside the VideoEvent as the provided AppUpdatedEvent
func (*VideoEvent) FromBlockedUserEvent ¶
func (t *VideoEvent) FromBlockedUserEvent(v BlockedUserEvent) error
FromBlockedUserEvent overwrites any union data inside the VideoEvent as the provided BlockedUserEvent
func (*VideoEvent) FromCallAcceptedEvent ¶
func (t *VideoEvent) FromCallAcceptedEvent(v CallAcceptedEvent) error
FromCallAcceptedEvent overwrites any union data inside the VideoEvent as the provided CallAcceptedEvent
func (*VideoEvent) FromCallClosedCaptionsFailedEvent ¶
func (t *VideoEvent) FromCallClosedCaptionsFailedEvent(v CallClosedCaptionsFailedEvent) error
FromCallClosedCaptionsFailedEvent overwrites any union data inside the VideoEvent as the provided CallClosedCaptionsFailedEvent
func (*VideoEvent) FromCallClosedCaptionsStartedEvent ¶
func (t *VideoEvent) FromCallClosedCaptionsStartedEvent(v CallClosedCaptionsStartedEvent) error
FromCallClosedCaptionsStartedEvent overwrites any union data inside the VideoEvent as the provided CallClosedCaptionsStartedEvent
func (*VideoEvent) FromCallClosedCaptionsStoppedEvent ¶
func (t *VideoEvent) FromCallClosedCaptionsStoppedEvent(v CallClosedCaptionsStoppedEvent) error
FromCallClosedCaptionsStoppedEvent overwrites any union data inside the VideoEvent as the provided CallClosedCaptionsStoppedEvent
func (*VideoEvent) FromCallCreatedEvent ¶
func (t *VideoEvent) FromCallCreatedEvent(v CallCreatedEvent) error
FromCallCreatedEvent overwrites any union data inside the VideoEvent as the provided CallCreatedEvent
func (*VideoEvent) FromCallDTMFEvent ¶
func (t *VideoEvent) FromCallDTMFEvent(v CallDTMFEvent) error
FromCallDTMFEvent overwrites any union data inside the VideoEvent as the provided CallDTMFEvent
func (*VideoEvent) FromCallDeletedEvent ¶
func (t *VideoEvent) FromCallDeletedEvent(v CallDeletedEvent) error
FromCallDeletedEvent overwrites any union data inside the VideoEvent as the provided CallDeletedEvent
func (*VideoEvent) FromCallEndedEvent ¶
func (t *VideoEvent) FromCallEndedEvent(v CallEndedEvent) error
FromCallEndedEvent overwrites any union data inside the VideoEvent as the provided CallEndedEvent
func (*VideoEvent) FromCallFrameRecordingFailedEvent ¶
func (t *VideoEvent) FromCallFrameRecordingFailedEvent(v CallFrameRecordingFailedEvent) error
FromCallFrameRecordingFailedEvent overwrites any union data inside the VideoEvent as the provided CallFrameRecordingFailedEvent
func (*VideoEvent) FromCallFrameRecordingFrameReadyEvent ¶
func (t *VideoEvent) FromCallFrameRecordingFrameReadyEvent(v CallFrameRecordingFrameReadyEvent) error
FromCallFrameRecordingFrameReadyEvent overwrites any union data inside the VideoEvent as the provided CallFrameRecordingFrameReadyEvent
func (*VideoEvent) FromCallFrameRecordingStartedEvent ¶
func (t *VideoEvent) FromCallFrameRecordingStartedEvent(v CallFrameRecordingStartedEvent) error
FromCallFrameRecordingStartedEvent overwrites any union data inside the VideoEvent as the provided CallFrameRecordingStartedEvent
func (*VideoEvent) FromCallFrameRecordingStoppedEvent ¶
func (t *VideoEvent) FromCallFrameRecordingStoppedEvent(v CallFrameRecordingStoppedEvent) error
FromCallFrameRecordingStoppedEvent overwrites any union data inside the VideoEvent as the provided CallFrameRecordingStoppedEvent
func (*VideoEvent) FromCallHLSBroadcastingFailedEvent ¶
func (t *VideoEvent) FromCallHLSBroadcastingFailedEvent(v CallHLSBroadcastingFailedEvent) error
FromCallHLSBroadcastingFailedEvent overwrites any union data inside the VideoEvent as the provided CallHLSBroadcastingFailedEvent
func (*VideoEvent) FromCallHLSBroadcastingStartedEvent ¶
func (t *VideoEvent) FromCallHLSBroadcastingStartedEvent(v CallHLSBroadcastingStartedEvent) error
FromCallHLSBroadcastingStartedEvent overwrites any union data inside the VideoEvent as the provided CallHLSBroadcastingStartedEvent
func (*VideoEvent) FromCallHLSBroadcastingStoppedEvent ¶
func (t *VideoEvent) FromCallHLSBroadcastingStoppedEvent(v CallHLSBroadcastingStoppedEvent) error
FromCallHLSBroadcastingStoppedEvent overwrites any union data inside the VideoEvent as the provided CallHLSBroadcastingStoppedEvent
func (*VideoEvent) FromCallLiveStartedEvent ¶
func (t *VideoEvent) FromCallLiveStartedEvent(v CallLiveStartedEvent) error
FromCallLiveStartedEvent overwrites any union data inside the VideoEvent as the provided CallLiveStartedEvent
func (*VideoEvent) FromCallMemberAddedEvent ¶
func (t *VideoEvent) FromCallMemberAddedEvent(v CallMemberAddedEvent) error
FromCallMemberAddedEvent overwrites any union data inside the VideoEvent as the provided CallMemberAddedEvent
func (*VideoEvent) FromCallMemberRemovedEvent ¶
func (t *VideoEvent) FromCallMemberRemovedEvent(v CallMemberRemovedEvent) error
FromCallMemberRemovedEvent overwrites any union data inside the VideoEvent as the provided CallMemberRemovedEvent
func (*VideoEvent) FromCallMemberUpdatedEvent ¶
func (t *VideoEvent) FromCallMemberUpdatedEvent(v CallMemberUpdatedEvent) error
FromCallMemberUpdatedEvent overwrites any union data inside the VideoEvent as the provided CallMemberUpdatedEvent
func (*VideoEvent) FromCallMemberUpdatedPermissionEvent ¶
func (t *VideoEvent) FromCallMemberUpdatedPermissionEvent(v CallMemberUpdatedPermissionEvent) error
FromCallMemberUpdatedPermissionEvent overwrites any union data inside the VideoEvent as the provided CallMemberUpdatedPermissionEvent
func (*VideoEvent) FromCallMissedEvent ¶
func (t *VideoEvent) FromCallMissedEvent(v CallMissedEvent) error
FromCallMissedEvent overwrites any union data inside the VideoEvent as the provided CallMissedEvent
func (*VideoEvent) FromCallModerationBlurEvent ¶
func (t *VideoEvent) FromCallModerationBlurEvent(v CallModerationBlurEvent) error
FromCallModerationBlurEvent overwrites any union data inside the VideoEvent as the provided CallModerationBlurEvent
func (*VideoEvent) FromCallModerationWarningEvent ¶
func (t *VideoEvent) FromCallModerationWarningEvent(v CallModerationWarningEvent) error
FromCallModerationWarningEvent overwrites any union data inside the VideoEvent as the provided CallModerationWarningEvent
func (*VideoEvent) FromCallNotificationEvent ¶
func (t *VideoEvent) FromCallNotificationEvent(v CallNotificationEvent) error
FromCallNotificationEvent overwrites any union data inside the VideoEvent as the provided CallNotificationEvent
func (*VideoEvent) FromCallReactionEvent ¶
func (t *VideoEvent) FromCallReactionEvent(v CallReactionEvent) error
FromCallReactionEvent overwrites any union data inside the VideoEvent as the provided CallReactionEvent
func (*VideoEvent) FromCallRecordingFailedEvent ¶
func (t *VideoEvent) FromCallRecordingFailedEvent(v CallRecordingFailedEvent) error
FromCallRecordingFailedEvent overwrites any union data inside the VideoEvent as the provided CallRecordingFailedEvent
func (*VideoEvent) FromCallRecordingReadyEvent ¶
func (t *VideoEvent) FromCallRecordingReadyEvent(v CallRecordingReadyEvent) error
FromCallRecordingReadyEvent overwrites any union data inside the VideoEvent as the provided CallRecordingReadyEvent
func (*VideoEvent) FromCallRecordingStartedEvent ¶
func (t *VideoEvent) FromCallRecordingStartedEvent(v CallRecordingStartedEvent) error
FromCallRecordingStartedEvent overwrites any union data inside the VideoEvent as the provided CallRecordingStartedEvent
func (*VideoEvent) FromCallRecordingStoppedEvent ¶
func (t *VideoEvent) FromCallRecordingStoppedEvent(v CallRecordingStoppedEvent) error
FromCallRecordingStoppedEvent overwrites any union data inside the VideoEvent as the provided CallRecordingStoppedEvent
func (*VideoEvent) FromCallRejectedEvent ¶
func (t *VideoEvent) FromCallRejectedEvent(v CallRejectedEvent) error
FromCallRejectedEvent overwrites any union data inside the VideoEvent as the provided CallRejectedEvent
func (*VideoEvent) FromCallRingEvent ¶
func (t *VideoEvent) FromCallRingEvent(v CallRingEvent) error
FromCallRingEvent overwrites any union data inside the VideoEvent as the provided CallRingEvent
func (*VideoEvent) FromCallRtmpBroadcastFailedEvent ¶
func (t *VideoEvent) FromCallRtmpBroadcastFailedEvent(v CallRtmpBroadcastFailedEvent) error
FromCallRtmpBroadcastFailedEvent overwrites any union data inside the VideoEvent as the provided CallRtmpBroadcastFailedEvent
func (*VideoEvent) FromCallRtmpBroadcastStartedEvent ¶
func (t *VideoEvent) FromCallRtmpBroadcastStartedEvent(v CallRtmpBroadcastStartedEvent) error
FromCallRtmpBroadcastStartedEvent overwrites any union data inside the VideoEvent as the provided CallRtmpBroadcastStartedEvent
func (*VideoEvent) FromCallRtmpBroadcastStoppedEvent ¶
func (t *VideoEvent) FromCallRtmpBroadcastStoppedEvent(v CallRtmpBroadcastStoppedEvent) error
FromCallRtmpBroadcastStoppedEvent overwrites any union data inside the VideoEvent as the provided CallRtmpBroadcastStoppedEvent
func (*VideoEvent) FromCallSessionEndedEvent ¶
func (t *VideoEvent) FromCallSessionEndedEvent(v CallSessionEndedEvent) error
FromCallSessionEndedEvent overwrites any union data inside the VideoEvent as the provided CallSessionEndedEvent
func (*VideoEvent) FromCallSessionParticipantCountsUpdatedEvent ¶
func (t *VideoEvent) FromCallSessionParticipantCountsUpdatedEvent(v CallSessionParticipantCountsUpdatedEvent) error
FromCallSessionParticipantCountsUpdatedEvent overwrites any union data inside the VideoEvent as the provided CallSessionParticipantCountsUpdatedEvent
func (*VideoEvent) FromCallSessionParticipantJoinedEvent ¶
func (t *VideoEvent) FromCallSessionParticipantJoinedEvent(v CallSessionParticipantJoinedEvent) error
FromCallSessionParticipantJoinedEvent overwrites any union data inside the VideoEvent as the provided CallSessionParticipantJoinedEvent
func (*VideoEvent) FromCallSessionParticipantLeftEvent ¶
func (t *VideoEvent) FromCallSessionParticipantLeftEvent(v CallSessionParticipantLeftEvent) error
FromCallSessionParticipantLeftEvent overwrites any union data inside the VideoEvent as the provided CallSessionParticipantLeftEvent
func (*VideoEvent) FromCallSessionStartedEvent ¶
func (t *VideoEvent) FromCallSessionStartedEvent(v CallSessionStartedEvent) error
FromCallSessionStartedEvent overwrites any union data inside the VideoEvent as the provided CallSessionStartedEvent
func (*VideoEvent) FromCallStatsReportReadyEvent ¶
func (t *VideoEvent) FromCallStatsReportReadyEvent(v CallStatsReportReadyEvent) error
FromCallStatsReportReadyEvent overwrites any union data inside the VideoEvent as the provided CallStatsReportReadyEvent
func (*VideoEvent) FromCallTranscriptionFailedEvent ¶
func (t *VideoEvent) FromCallTranscriptionFailedEvent(v CallTranscriptionFailedEvent) error
FromCallTranscriptionFailedEvent overwrites any union data inside the VideoEvent as the provided CallTranscriptionFailedEvent
func (*VideoEvent) FromCallTranscriptionReadyEvent ¶
func (t *VideoEvent) FromCallTranscriptionReadyEvent(v CallTranscriptionReadyEvent) error
FromCallTranscriptionReadyEvent overwrites any union data inside the VideoEvent as the provided CallTranscriptionReadyEvent
func (*VideoEvent) FromCallTranscriptionStartedEvent ¶
func (t *VideoEvent) FromCallTranscriptionStartedEvent(v CallTranscriptionStartedEvent) error
FromCallTranscriptionStartedEvent overwrites any union data inside the VideoEvent as the provided CallTranscriptionStartedEvent
func (*VideoEvent) FromCallTranscriptionStoppedEvent ¶
func (t *VideoEvent) FromCallTranscriptionStoppedEvent(v CallTranscriptionStoppedEvent) error
FromCallTranscriptionStoppedEvent overwrites any union data inside the VideoEvent as the provided CallTranscriptionStoppedEvent
func (*VideoEvent) FromCallUpdatedEvent ¶
func (t *VideoEvent) FromCallUpdatedEvent(v CallUpdatedEvent) error
FromCallUpdatedEvent overwrites any union data inside the VideoEvent as the provided CallUpdatedEvent
func (*VideoEvent) FromCallUserFeedbackSubmittedEvent ¶
func (t *VideoEvent) FromCallUserFeedbackSubmittedEvent(v CallUserFeedbackSubmittedEvent) error
FromCallUserFeedbackSubmittedEvent overwrites any union data inside the VideoEvent as the provided CallUserFeedbackSubmittedEvent
func (*VideoEvent) FromCallUserMutedEvent ¶
func (t *VideoEvent) FromCallUserMutedEvent(v CallUserMutedEvent) error
FromCallUserMutedEvent overwrites any union data inside the VideoEvent as the provided CallUserMutedEvent
func (*VideoEvent) FromClosedCaptionEvent ¶
func (t *VideoEvent) FromClosedCaptionEvent(v ClosedCaptionEvent) error
FromClosedCaptionEvent overwrites any union data inside the VideoEvent as the provided ClosedCaptionEvent
func (*VideoEvent) FromConnectedEvent ¶
func (t *VideoEvent) FromConnectedEvent(v ConnectedEvent) error
FromConnectedEvent overwrites any union data inside the VideoEvent as the provided ConnectedEvent
func (*VideoEvent) FromConnectionErrorEvent ¶
func (t *VideoEvent) FromConnectionErrorEvent(v ConnectionErrorEvent) error
FromConnectionErrorEvent overwrites any union data inside the VideoEvent as the provided ConnectionErrorEvent
func (*VideoEvent) FromCustomVideoEvent ¶
func (t *VideoEvent) FromCustomVideoEvent(v CustomVideoEvent) error
FromCustomVideoEvent overwrites any union data inside the VideoEvent as the provided CustomVideoEvent
func (*VideoEvent) FromHealthCheckEvent ¶
func (t *VideoEvent) FromHealthCheckEvent(v HealthCheckEvent) error
FromHealthCheckEvent overwrites any union data inside the VideoEvent as the provided HealthCheckEvent
func (*VideoEvent) FromIngressErrorEvent ¶
func (t *VideoEvent) FromIngressErrorEvent(v IngressErrorEvent) error
FromIngressErrorEvent overwrites any union data inside the VideoEvent as the provided IngressErrorEvent
func (*VideoEvent) FromIngressStartedEvent ¶
func (t *VideoEvent) FromIngressStartedEvent(v IngressStartedEvent) error
FromIngressStartedEvent overwrites any union data inside the VideoEvent as the provided IngressStartedEvent
func (*VideoEvent) FromIngressStoppedEvent ¶
func (t *VideoEvent) FromIngressStoppedEvent(v IngressStoppedEvent) error
FromIngressStoppedEvent overwrites any union data inside the VideoEvent as the provided IngressStoppedEvent
func (*VideoEvent) FromKickedUserEvent ¶
func (t *VideoEvent) FromKickedUserEvent(v KickedUserEvent) error
FromKickedUserEvent overwrites any union data inside the VideoEvent as the provided KickedUserEvent
func (*VideoEvent) FromPermissionRequestEvent ¶
func (t *VideoEvent) FromPermissionRequestEvent(v PermissionRequestEvent) error
FromPermissionRequestEvent overwrites any union data inside the VideoEvent as the provided PermissionRequestEvent
func (*VideoEvent) FromUnblockedUserEvent ¶
func (t *VideoEvent) FromUnblockedUserEvent(v UnblockedUserEvent) error
FromUnblockedUserEvent overwrites any union data inside the VideoEvent as the provided UnblockedUserEvent
func (*VideoEvent) FromUpdatedCallPermissionsEvent ¶
func (t *VideoEvent) FromUpdatedCallPermissionsEvent(v UpdatedCallPermissionsEvent) error
FromUpdatedCallPermissionsEvent overwrites any union data inside the VideoEvent as the provided UpdatedCallPermissionsEvent
func (*VideoEvent) FromUserBannedEvent ¶
func (t *VideoEvent) FromUserBannedEvent(v UserBannedEvent) error
FromUserBannedEvent overwrites any union data inside the VideoEvent as the provided UserBannedEvent
func (*VideoEvent) FromUserDeactivatedEvent ¶
func (t *VideoEvent) FromUserDeactivatedEvent(v UserDeactivatedEvent) error
FromUserDeactivatedEvent overwrites any union data inside the VideoEvent as the provided UserDeactivatedEvent
func (*VideoEvent) FromUserDeletedEvent ¶
func (t *VideoEvent) FromUserDeletedEvent(v UserDeletedEvent) error
FromUserDeletedEvent overwrites any union data inside the VideoEvent as the provided UserDeletedEvent
func (*VideoEvent) FromUserPresenceChangedEvent ¶
func (t *VideoEvent) FromUserPresenceChangedEvent(v UserPresenceChangedEvent) error
FromUserPresenceChangedEvent overwrites any union data inside the VideoEvent as the provided UserPresenceChangedEvent
func (*VideoEvent) FromUserReactivatedEvent ¶
func (t *VideoEvent) FromUserReactivatedEvent(v UserReactivatedEvent) error
FromUserReactivatedEvent overwrites any union data inside the VideoEvent as the provided UserReactivatedEvent
func (*VideoEvent) FromUserUnbannedEvent ¶
func (t *VideoEvent) FromUserUnbannedEvent(v UserUnbannedEvent) error
FromUserUnbannedEvent overwrites any union data inside the VideoEvent as the provided UserUnbannedEvent
func (*VideoEvent) FromUserUpdatedEvent ¶
func (t *VideoEvent) FromUserUpdatedEvent(v UserUpdatedEvent) error
FromUserUpdatedEvent overwrites any union data inside the VideoEvent as the provided UserUpdatedEvent
func (VideoEvent) MarshalJSON ¶
func (t VideoEvent) MarshalJSON() ([]byte, error)
func (*VideoEvent) MergeAppUpdatedEvent ¶
func (t *VideoEvent) MergeAppUpdatedEvent(v AppUpdatedEvent) error
MergeAppUpdatedEvent performs a merge with any union data inside the VideoEvent, using the provided AppUpdatedEvent
func (*VideoEvent) MergeBlockedUserEvent ¶
func (t *VideoEvent) MergeBlockedUserEvent(v BlockedUserEvent) error
MergeBlockedUserEvent performs a merge with any union data inside the VideoEvent, using the provided BlockedUserEvent
func (*VideoEvent) MergeCallAcceptedEvent ¶
func (t *VideoEvent) MergeCallAcceptedEvent(v CallAcceptedEvent) error
MergeCallAcceptedEvent performs a merge with any union data inside the VideoEvent, using the provided CallAcceptedEvent
func (*VideoEvent) MergeCallClosedCaptionsFailedEvent ¶
func (t *VideoEvent) MergeCallClosedCaptionsFailedEvent(v CallClosedCaptionsFailedEvent) error
MergeCallClosedCaptionsFailedEvent performs a merge with any union data inside the VideoEvent, using the provided CallClosedCaptionsFailedEvent
func (*VideoEvent) MergeCallClosedCaptionsStartedEvent ¶
func (t *VideoEvent) MergeCallClosedCaptionsStartedEvent(v CallClosedCaptionsStartedEvent) error
MergeCallClosedCaptionsStartedEvent performs a merge with any union data inside the VideoEvent, using the provided CallClosedCaptionsStartedEvent
func (*VideoEvent) MergeCallClosedCaptionsStoppedEvent ¶
func (t *VideoEvent) MergeCallClosedCaptionsStoppedEvent(v CallClosedCaptionsStoppedEvent) error
MergeCallClosedCaptionsStoppedEvent performs a merge with any union data inside the VideoEvent, using the provided CallClosedCaptionsStoppedEvent
func (*VideoEvent) MergeCallCreatedEvent ¶
func (t *VideoEvent) MergeCallCreatedEvent(v CallCreatedEvent) error
MergeCallCreatedEvent performs a merge with any union data inside the VideoEvent, using the provided CallCreatedEvent
func (*VideoEvent) MergeCallDTMFEvent ¶
func (t *VideoEvent) MergeCallDTMFEvent(v CallDTMFEvent) error
MergeCallDTMFEvent performs a merge with any union data inside the VideoEvent, using the provided CallDTMFEvent
func (*VideoEvent) MergeCallDeletedEvent ¶
func (t *VideoEvent) MergeCallDeletedEvent(v CallDeletedEvent) error
MergeCallDeletedEvent performs a merge with any union data inside the VideoEvent, using the provided CallDeletedEvent
func (*VideoEvent) MergeCallEndedEvent ¶
func (t *VideoEvent) MergeCallEndedEvent(v CallEndedEvent) error
MergeCallEndedEvent performs a merge with any union data inside the VideoEvent, using the provided CallEndedEvent
func (*VideoEvent) MergeCallFrameRecordingFailedEvent ¶
func (t *VideoEvent) MergeCallFrameRecordingFailedEvent(v CallFrameRecordingFailedEvent) error
MergeCallFrameRecordingFailedEvent performs a merge with any union data inside the VideoEvent, using the provided CallFrameRecordingFailedEvent
func (*VideoEvent) MergeCallFrameRecordingFrameReadyEvent ¶
func (t *VideoEvent) MergeCallFrameRecordingFrameReadyEvent(v CallFrameRecordingFrameReadyEvent) error
MergeCallFrameRecordingFrameReadyEvent performs a merge with any union data inside the VideoEvent, using the provided CallFrameRecordingFrameReadyEvent
func (*VideoEvent) MergeCallFrameRecordingStartedEvent ¶
func (t *VideoEvent) MergeCallFrameRecordingStartedEvent(v CallFrameRecordingStartedEvent) error
MergeCallFrameRecordingStartedEvent performs a merge with any union data inside the VideoEvent, using the provided CallFrameRecordingStartedEvent
func (*VideoEvent) MergeCallFrameRecordingStoppedEvent ¶
func (t *VideoEvent) MergeCallFrameRecordingStoppedEvent(v CallFrameRecordingStoppedEvent) error
MergeCallFrameRecordingStoppedEvent performs a merge with any union data inside the VideoEvent, using the provided CallFrameRecordingStoppedEvent
func (*VideoEvent) MergeCallHLSBroadcastingFailedEvent ¶
func (t *VideoEvent) MergeCallHLSBroadcastingFailedEvent(v CallHLSBroadcastingFailedEvent) error
MergeCallHLSBroadcastingFailedEvent performs a merge with any union data inside the VideoEvent, using the provided CallHLSBroadcastingFailedEvent
func (*VideoEvent) MergeCallHLSBroadcastingStartedEvent ¶
func (t *VideoEvent) MergeCallHLSBroadcastingStartedEvent(v CallHLSBroadcastingStartedEvent) error
MergeCallHLSBroadcastingStartedEvent performs a merge with any union data inside the VideoEvent, using the provided CallHLSBroadcastingStartedEvent
func (*VideoEvent) MergeCallHLSBroadcastingStoppedEvent ¶
func (t *VideoEvent) MergeCallHLSBroadcastingStoppedEvent(v CallHLSBroadcastingStoppedEvent) error
MergeCallHLSBroadcastingStoppedEvent performs a merge with any union data inside the VideoEvent, using the provided CallHLSBroadcastingStoppedEvent
func (*VideoEvent) MergeCallLiveStartedEvent ¶
func (t *VideoEvent) MergeCallLiveStartedEvent(v CallLiveStartedEvent) error
MergeCallLiveStartedEvent performs a merge with any union data inside the VideoEvent, using the provided CallLiveStartedEvent
func (*VideoEvent) MergeCallMemberAddedEvent ¶
func (t *VideoEvent) MergeCallMemberAddedEvent(v CallMemberAddedEvent) error
MergeCallMemberAddedEvent performs a merge with any union data inside the VideoEvent, using the provided CallMemberAddedEvent
func (*VideoEvent) MergeCallMemberRemovedEvent ¶
func (t *VideoEvent) MergeCallMemberRemovedEvent(v CallMemberRemovedEvent) error
MergeCallMemberRemovedEvent performs a merge with any union data inside the VideoEvent, using the provided CallMemberRemovedEvent
func (*VideoEvent) MergeCallMemberUpdatedEvent ¶
func (t *VideoEvent) MergeCallMemberUpdatedEvent(v CallMemberUpdatedEvent) error
MergeCallMemberUpdatedEvent performs a merge with any union data inside the VideoEvent, using the provided CallMemberUpdatedEvent
func (*VideoEvent) MergeCallMemberUpdatedPermissionEvent ¶
func (t *VideoEvent) MergeCallMemberUpdatedPermissionEvent(v CallMemberUpdatedPermissionEvent) error
MergeCallMemberUpdatedPermissionEvent performs a merge with any union data inside the VideoEvent, using the provided CallMemberUpdatedPermissionEvent
func (*VideoEvent) MergeCallMissedEvent ¶
func (t *VideoEvent) MergeCallMissedEvent(v CallMissedEvent) error
MergeCallMissedEvent performs a merge with any union data inside the VideoEvent, using the provided CallMissedEvent
func (*VideoEvent) MergeCallModerationBlurEvent ¶
func (t *VideoEvent) MergeCallModerationBlurEvent(v CallModerationBlurEvent) error
MergeCallModerationBlurEvent performs a merge with any union data inside the VideoEvent, using the provided CallModerationBlurEvent
func (*VideoEvent) MergeCallModerationWarningEvent ¶
func (t *VideoEvent) MergeCallModerationWarningEvent(v CallModerationWarningEvent) error
MergeCallModerationWarningEvent performs a merge with any union data inside the VideoEvent, using the provided CallModerationWarningEvent
func (*VideoEvent) MergeCallNotificationEvent ¶
func (t *VideoEvent) MergeCallNotificationEvent(v CallNotificationEvent) error
MergeCallNotificationEvent performs a merge with any union data inside the VideoEvent, using the provided CallNotificationEvent
func (*VideoEvent) MergeCallReactionEvent ¶
func (t *VideoEvent) MergeCallReactionEvent(v CallReactionEvent) error
MergeCallReactionEvent performs a merge with any union data inside the VideoEvent, using the provided CallReactionEvent
func (*VideoEvent) MergeCallRecordingFailedEvent ¶
func (t *VideoEvent) MergeCallRecordingFailedEvent(v CallRecordingFailedEvent) error
MergeCallRecordingFailedEvent performs a merge with any union data inside the VideoEvent, using the provided CallRecordingFailedEvent
func (*VideoEvent) MergeCallRecordingReadyEvent ¶
func (t *VideoEvent) MergeCallRecordingReadyEvent(v CallRecordingReadyEvent) error
MergeCallRecordingReadyEvent performs a merge with any union data inside the VideoEvent, using the provided CallRecordingReadyEvent
func (*VideoEvent) MergeCallRecordingStartedEvent ¶
func (t *VideoEvent) MergeCallRecordingStartedEvent(v CallRecordingStartedEvent) error
MergeCallRecordingStartedEvent performs a merge with any union data inside the VideoEvent, using the provided CallRecordingStartedEvent
func (*VideoEvent) MergeCallRecordingStoppedEvent ¶
func (t *VideoEvent) MergeCallRecordingStoppedEvent(v CallRecordingStoppedEvent) error
MergeCallRecordingStoppedEvent performs a merge with any union data inside the VideoEvent, using the provided CallRecordingStoppedEvent
func (*VideoEvent) MergeCallRejectedEvent ¶
func (t *VideoEvent) MergeCallRejectedEvent(v CallRejectedEvent) error
MergeCallRejectedEvent performs a merge with any union data inside the VideoEvent, using the provided CallRejectedEvent
func (*VideoEvent) MergeCallRingEvent ¶
func (t *VideoEvent) MergeCallRingEvent(v CallRingEvent) error
MergeCallRingEvent performs a merge with any union data inside the VideoEvent, using the provided CallRingEvent
func (*VideoEvent) MergeCallRtmpBroadcastFailedEvent ¶
func (t *VideoEvent) MergeCallRtmpBroadcastFailedEvent(v CallRtmpBroadcastFailedEvent) error
MergeCallRtmpBroadcastFailedEvent performs a merge with any union data inside the VideoEvent, using the provided CallRtmpBroadcastFailedEvent
func (*VideoEvent) MergeCallRtmpBroadcastStartedEvent ¶
func (t *VideoEvent) MergeCallRtmpBroadcastStartedEvent(v CallRtmpBroadcastStartedEvent) error
MergeCallRtmpBroadcastStartedEvent performs a merge with any union data inside the VideoEvent, using the provided CallRtmpBroadcastStartedEvent
func (*VideoEvent) MergeCallRtmpBroadcastStoppedEvent ¶
func (t *VideoEvent) MergeCallRtmpBroadcastStoppedEvent(v CallRtmpBroadcastStoppedEvent) error
MergeCallRtmpBroadcastStoppedEvent performs a merge with any union data inside the VideoEvent, using the provided CallRtmpBroadcastStoppedEvent
func (*VideoEvent) MergeCallSessionEndedEvent ¶
func (t *VideoEvent) MergeCallSessionEndedEvent(v CallSessionEndedEvent) error
MergeCallSessionEndedEvent performs a merge with any union data inside the VideoEvent, using the provided CallSessionEndedEvent
func (*VideoEvent) MergeCallSessionParticipantCountsUpdatedEvent ¶
func (t *VideoEvent) MergeCallSessionParticipantCountsUpdatedEvent(v CallSessionParticipantCountsUpdatedEvent) error
MergeCallSessionParticipantCountsUpdatedEvent performs a merge with any union data inside the VideoEvent, using the provided CallSessionParticipantCountsUpdatedEvent
func (*VideoEvent) MergeCallSessionParticipantJoinedEvent ¶
func (t *VideoEvent) MergeCallSessionParticipantJoinedEvent(v CallSessionParticipantJoinedEvent) error
MergeCallSessionParticipantJoinedEvent performs a merge with any union data inside the VideoEvent, using the provided CallSessionParticipantJoinedEvent
func (*VideoEvent) MergeCallSessionParticipantLeftEvent ¶
func (t *VideoEvent) MergeCallSessionParticipantLeftEvent(v CallSessionParticipantLeftEvent) error
MergeCallSessionParticipantLeftEvent performs a merge with any union data inside the VideoEvent, using the provided CallSessionParticipantLeftEvent
func (*VideoEvent) MergeCallSessionStartedEvent ¶
func (t *VideoEvent) MergeCallSessionStartedEvent(v CallSessionStartedEvent) error
MergeCallSessionStartedEvent performs a merge with any union data inside the VideoEvent, using the provided CallSessionStartedEvent
func (*VideoEvent) MergeCallStatsReportReadyEvent ¶
func (t *VideoEvent) MergeCallStatsReportReadyEvent(v CallStatsReportReadyEvent) error
MergeCallStatsReportReadyEvent performs a merge with any union data inside the VideoEvent, using the provided CallStatsReportReadyEvent
func (*VideoEvent) MergeCallTranscriptionFailedEvent ¶
func (t *VideoEvent) MergeCallTranscriptionFailedEvent(v CallTranscriptionFailedEvent) error
MergeCallTranscriptionFailedEvent performs a merge with any union data inside the VideoEvent, using the provided CallTranscriptionFailedEvent
func (*VideoEvent) MergeCallTranscriptionReadyEvent ¶
func (t *VideoEvent) MergeCallTranscriptionReadyEvent(v CallTranscriptionReadyEvent) error
MergeCallTranscriptionReadyEvent performs a merge with any union data inside the VideoEvent, using the provided CallTranscriptionReadyEvent
func (*VideoEvent) MergeCallTranscriptionStartedEvent ¶
func (t *VideoEvent) MergeCallTranscriptionStartedEvent(v CallTranscriptionStartedEvent) error
MergeCallTranscriptionStartedEvent performs a merge with any union data inside the VideoEvent, using the provided CallTranscriptionStartedEvent
func (*VideoEvent) MergeCallTranscriptionStoppedEvent ¶
func (t *VideoEvent) MergeCallTranscriptionStoppedEvent(v CallTranscriptionStoppedEvent) error
MergeCallTranscriptionStoppedEvent performs a merge with any union data inside the VideoEvent, using the provided CallTranscriptionStoppedEvent
func (*VideoEvent) MergeCallUpdatedEvent ¶
func (t *VideoEvent) MergeCallUpdatedEvent(v CallUpdatedEvent) error
MergeCallUpdatedEvent performs a merge with any union data inside the VideoEvent, using the provided CallUpdatedEvent
func (*VideoEvent) MergeCallUserFeedbackSubmittedEvent ¶
func (t *VideoEvent) MergeCallUserFeedbackSubmittedEvent(v CallUserFeedbackSubmittedEvent) error
MergeCallUserFeedbackSubmittedEvent performs a merge with any union data inside the VideoEvent, using the provided CallUserFeedbackSubmittedEvent
func (*VideoEvent) MergeCallUserMutedEvent ¶
func (t *VideoEvent) MergeCallUserMutedEvent(v CallUserMutedEvent) error
MergeCallUserMutedEvent performs a merge with any union data inside the VideoEvent, using the provided CallUserMutedEvent
func (*VideoEvent) MergeClosedCaptionEvent ¶
func (t *VideoEvent) MergeClosedCaptionEvent(v ClosedCaptionEvent) error
MergeClosedCaptionEvent performs a merge with any union data inside the VideoEvent, using the provided ClosedCaptionEvent
func (*VideoEvent) MergeConnectedEvent ¶
func (t *VideoEvent) MergeConnectedEvent(v ConnectedEvent) error
MergeConnectedEvent performs a merge with any union data inside the VideoEvent, using the provided ConnectedEvent
func (*VideoEvent) MergeConnectionErrorEvent ¶
func (t *VideoEvent) MergeConnectionErrorEvent(v ConnectionErrorEvent) error
MergeConnectionErrorEvent performs a merge with any union data inside the VideoEvent, using the provided ConnectionErrorEvent
func (*VideoEvent) MergeCustomVideoEvent ¶
func (t *VideoEvent) MergeCustomVideoEvent(v CustomVideoEvent) error
MergeCustomVideoEvent performs a merge with any union data inside the VideoEvent, using the provided CustomVideoEvent
func (*VideoEvent) MergeHealthCheckEvent ¶
func (t *VideoEvent) MergeHealthCheckEvent(v HealthCheckEvent) error
MergeHealthCheckEvent performs a merge with any union data inside the VideoEvent, using the provided HealthCheckEvent
func (*VideoEvent) MergeIngressErrorEvent ¶
func (t *VideoEvent) MergeIngressErrorEvent(v IngressErrorEvent) error
MergeIngressErrorEvent performs a merge with any union data inside the VideoEvent, using the provided IngressErrorEvent
func (*VideoEvent) MergeIngressStartedEvent ¶
func (t *VideoEvent) MergeIngressStartedEvent(v IngressStartedEvent) error
MergeIngressStartedEvent performs a merge with any union data inside the VideoEvent, using the provided IngressStartedEvent
func (*VideoEvent) MergeIngressStoppedEvent ¶
func (t *VideoEvent) MergeIngressStoppedEvent(v IngressStoppedEvent) error
MergeIngressStoppedEvent performs a merge with any union data inside the VideoEvent, using the provided IngressStoppedEvent
func (*VideoEvent) MergeKickedUserEvent ¶
func (t *VideoEvent) MergeKickedUserEvent(v KickedUserEvent) error
MergeKickedUserEvent performs a merge with any union data inside the VideoEvent, using the provided KickedUserEvent
func (*VideoEvent) MergePermissionRequestEvent ¶
func (t *VideoEvent) MergePermissionRequestEvent(v PermissionRequestEvent) error
MergePermissionRequestEvent performs a merge with any union data inside the VideoEvent, using the provided PermissionRequestEvent
func (*VideoEvent) MergeUnblockedUserEvent ¶
func (t *VideoEvent) MergeUnblockedUserEvent(v UnblockedUserEvent) error
MergeUnblockedUserEvent performs a merge with any union data inside the VideoEvent, using the provided UnblockedUserEvent
func (*VideoEvent) MergeUpdatedCallPermissionsEvent ¶
func (t *VideoEvent) MergeUpdatedCallPermissionsEvent(v UpdatedCallPermissionsEvent) error
MergeUpdatedCallPermissionsEvent performs a merge with any union data inside the VideoEvent, using the provided UpdatedCallPermissionsEvent
func (*VideoEvent) MergeUserBannedEvent ¶
func (t *VideoEvent) MergeUserBannedEvent(v UserBannedEvent) error
MergeUserBannedEvent performs a merge with any union data inside the VideoEvent, using the provided UserBannedEvent
func (*VideoEvent) MergeUserDeactivatedEvent ¶
func (t *VideoEvent) MergeUserDeactivatedEvent(v UserDeactivatedEvent) error
MergeUserDeactivatedEvent performs a merge with any union data inside the VideoEvent, using the provided UserDeactivatedEvent
func (*VideoEvent) MergeUserDeletedEvent ¶
func (t *VideoEvent) MergeUserDeletedEvent(v UserDeletedEvent) error
MergeUserDeletedEvent performs a merge with any union data inside the VideoEvent, using the provided UserDeletedEvent
func (*VideoEvent) MergeUserPresenceChangedEvent ¶
func (t *VideoEvent) MergeUserPresenceChangedEvent(v UserPresenceChangedEvent) error
MergeUserPresenceChangedEvent performs a merge with any union data inside the VideoEvent, using the provided UserPresenceChangedEvent
func (*VideoEvent) MergeUserReactivatedEvent ¶
func (t *VideoEvent) MergeUserReactivatedEvent(v UserReactivatedEvent) error
MergeUserReactivatedEvent performs a merge with any union data inside the VideoEvent, using the provided UserReactivatedEvent
func (*VideoEvent) MergeUserUnbannedEvent ¶
func (t *VideoEvent) MergeUserUnbannedEvent(v UserUnbannedEvent) error
MergeUserUnbannedEvent performs a merge with any union data inside the VideoEvent, using the provided UserUnbannedEvent
func (*VideoEvent) MergeUserUpdatedEvent ¶
func (t *VideoEvent) MergeUserUpdatedEvent(v UserUpdatedEvent) error
MergeUserUpdatedEvent performs a merge with any union data inside the VideoEvent, using the provided UserUpdatedEvent
func (*VideoEvent) UnmarshalJSON ¶
func (t *VideoEvent) UnmarshalJSON(b []byte) error
func (VideoEvent) ValueByDiscriminator ¶
func (t VideoEvent) ValueByDiscriminator() (interface{}, error)
type VideoPinJSONRequestBody ¶
type VideoPinJSONRequestBody = PinRequest
VideoPinJSONRequestBody defines body for VideoPin for application/json ContentType.
type VideoReactionOverTimeResponse ¶
type VideoReactionOverTimeResponse struct {
ByMinute *[]*CountByMinuteResponse `json:"by_minute,omitempty"`
}
VideoReactionOverTimeResponse defines model for VideoReactionOverTimeResponse.
type VideoReactionResponse ¶
type VideoReactionResponse struct {
Custom *map[string]interface{} `json:"custom,omitempty"`
EmojiCode *string `json:"emoji_code,omitempty"`
Type string `json:"type"`
// User User response object
User UserResponse `json:"user"`
}
VideoReactionResponse defines model for VideoReactionResponse.
type VideoReactionsResponse ¶
type VideoReactionsResponse struct {
CountOverTime *VideoReactionOverTimeResponse `json:"count_over_time,omitempty"`
Reaction string `json:"reaction"`
}
VideoReactionsResponse defines model for VideoReactionsResponse.
type VideoSettingsRequest ¶
type VideoSettingsRequest struct {
AccessRequestEnabled *bool `json:"access_request_enabled,omitempty"`
CameraDefaultOn *bool `json:"camera_default_on,omitempty"`
CameraFacing *VideoSettingsRequestCameraFacing `json:"camera_facing,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
TargetResolution *TargetResolution `json:"target_resolution,omitempty"`
}
VideoSettingsRequest defines model for VideoSettingsRequest.
type VideoSettingsRequestCameraFacing ¶
type VideoSettingsRequestCameraFacing string
VideoSettingsRequestCameraFacing defines model for VideoSettingsRequest.CameraFacing.
const ( VideoSettingsRequestCameraFacingBack VideoSettingsRequestCameraFacing = "back" VideoSettingsRequestCameraFacingExternal VideoSettingsRequestCameraFacing = "external" VideoSettingsRequestCameraFacingFront VideoSettingsRequestCameraFacing = "front" )
Defines values for VideoSettingsRequestCameraFacing.
func (VideoSettingsRequestCameraFacing) Valid ¶
func (e VideoSettingsRequestCameraFacing) Valid() bool
Valid indicates whether the value is a known member of the VideoSettingsRequestCameraFacing enum.
type VideoSettingsResponse ¶
type VideoSettingsResponse struct {
AccessRequestEnabled bool `json:"access_request_enabled"`
CameraDefaultOn bool `json:"camera_default_on"`
CameraFacing VideoSettingsResponseCameraFacing `json:"camera_facing"`
Enabled bool `json:"enabled"`
TargetResolution TargetResolution `json:"target_resolution"`
}
VideoSettingsResponse defines model for VideoSettingsResponse.
type VideoSettingsResponseCameraFacing ¶
type VideoSettingsResponseCameraFacing string
VideoSettingsResponseCameraFacing defines model for VideoSettingsResponse.CameraFacing.
const ( VideoSettingsResponseCameraFacingBack VideoSettingsResponseCameraFacing = "back" VideoSettingsResponseCameraFacingExternal VideoSettingsResponseCameraFacing = "external" VideoSettingsResponseCameraFacingFront VideoSettingsResponseCameraFacing = "front" )
Defines values for VideoSettingsResponseCameraFacing.
func (VideoSettingsResponseCameraFacing) Valid ¶
func (e VideoSettingsResponseCameraFacing) Valid() bool
Valid indicates whether the value is a known member of the VideoSettingsResponseCameraFacing enum.
type VideoUnpinJSONRequestBody ¶
type VideoUnpinJSONRequestBody = UnpinRequest
VideoUnpinJSONRequestBody defines body for VideoUnpin for application/json ContentType.
type ViewerBehavior ¶
type ViewerBehavior struct {
BounceRatePct *float64 `json:"bounce_rate_pct,omitempty"`
ConnectionDurationP50S int64 `json:"connection_duration_p50_s"`
ConnectionsPerViewerMean float64 `json:"connections_per_viewer_mean"`
ConnectionsUnder30SPct *float64 `json:"connections_under_30s_pct,omitempty"`
MedianWatchMin float64 `json:"median_watch_min"`
Note string `json:"note"`
P90WatchMin float64 `json:"p90_watch_min"`
ReturnVisitRatePct *float64 `json:"return_visit_rate_pct,omitempty"`
}
ViewerBehavior defines model for ViewerBehavior.
type WHIPIngress ¶
type WHIPIngress struct {
// Address URL for a new whip input, every time a new link is created
Address string `json:"address"`
}
WHIPIngress defines model for WHIPIngress.
type WSAuthMessage ¶
type WSAuthMessage struct {
// MemberCustomInclude Channel-member custom keys to project onto message.member for messages this connection receives (opt-in; capped, off by default).
MemberCustomInclude *[]string `json:"member_custom_include,omitempty"`
// Products List of products to subscribe to. One of: chat, video, feeds
Products *[]WSAuthMessageProducts `json:"products,omitempty"`
// Token JWT token for authentication
Token string `json:"token"`
UserDetails ConnectUserDetailsRequest `json:"user_details"`
}
WSAuthMessage Websocket auth message
type WSAuthMessageProducts ¶
type WSAuthMessageProducts string
WSAuthMessageProducts defines model for WSAuthMessage.Products.
const ( Chat WSAuthMessageProducts = "chat" Feeds WSAuthMessageProducts = "feeds" Video WSAuthMessageProducts = "video" )
Defines values for WSAuthMessageProducts.
func (WSAuthMessageProducts) Valid ¶
func (e WSAuthMessageProducts) Valid() bool
Valid indicates whether the value is a known member of the WSAuthMessageProducts enum.
type WSCallEvent ¶
type WSCallEvent struct {
// contains filtered or unexported fields
}
WSCallEvent The discriminator object for all websocket call events, it maps events' payload to the final type
func (WSCallEvent) AsCallDTMFEvent ¶
func (t WSCallEvent) AsCallDTMFEvent() (CallDTMFEvent, error)
AsCallDTMFEvent returns the union data inside the WSCallEvent as a CallDTMFEvent
func (WSCallEvent) AsIngressErrorEvent ¶
func (t WSCallEvent) AsIngressErrorEvent() (IngressErrorEvent, error)
AsIngressErrorEvent returns the union data inside the WSCallEvent as a IngressErrorEvent
func (WSCallEvent) AsIngressStartedEvent ¶
func (t WSCallEvent) AsIngressStartedEvent() (IngressStartedEvent, error)
AsIngressStartedEvent returns the union data inside the WSCallEvent as a IngressStartedEvent
func (WSCallEvent) AsIngressStoppedEvent ¶
func (t WSCallEvent) AsIngressStoppedEvent() (IngressStoppedEvent, error)
AsIngressStoppedEvent returns the union data inside the WSCallEvent as a IngressStoppedEvent
func (WSCallEvent) Discriminator ¶
func (t WSCallEvent) Discriminator() (string, error)
func (*WSCallEvent) FromCallDTMFEvent ¶
func (t *WSCallEvent) FromCallDTMFEvent(v CallDTMFEvent) error
FromCallDTMFEvent overwrites any union data inside the WSCallEvent as the provided CallDTMFEvent
func (*WSCallEvent) FromIngressErrorEvent ¶
func (t *WSCallEvent) FromIngressErrorEvent(v IngressErrorEvent) error
FromIngressErrorEvent overwrites any union data inside the WSCallEvent as the provided IngressErrorEvent
func (*WSCallEvent) FromIngressStartedEvent ¶
func (t *WSCallEvent) FromIngressStartedEvent(v IngressStartedEvent) error
FromIngressStartedEvent overwrites any union data inside the WSCallEvent as the provided IngressStartedEvent
func (*WSCallEvent) FromIngressStoppedEvent ¶
func (t *WSCallEvent) FromIngressStoppedEvent(v IngressStoppedEvent) error
FromIngressStoppedEvent overwrites any union data inside the WSCallEvent as the provided IngressStoppedEvent
func (WSCallEvent) MarshalJSON ¶
func (t WSCallEvent) MarshalJSON() ([]byte, error)
func (*WSCallEvent) MergeCallDTMFEvent ¶
func (t *WSCallEvent) MergeCallDTMFEvent(v CallDTMFEvent) error
MergeCallDTMFEvent performs a merge with any union data inside the WSCallEvent, using the provided CallDTMFEvent
func (*WSCallEvent) MergeIngressErrorEvent ¶
func (t *WSCallEvent) MergeIngressErrorEvent(v IngressErrorEvent) error
MergeIngressErrorEvent performs a merge with any union data inside the WSCallEvent, using the provided IngressErrorEvent
func (*WSCallEvent) MergeIngressStartedEvent ¶
func (t *WSCallEvent) MergeIngressStartedEvent(v IngressStartedEvent) error
MergeIngressStartedEvent performs a merge with any union data inside the WSCallEvent, using the provided IngressStartedEvent
func (*WSCallEvent) MergeIngressStoppedEvent ¶
func (t *WSCallEvent) MergeIngressStoppedEvent(v IngressStoppedEvent) error
MergeIngressStoppedEvent performs a merge with any union data inside the WSCallEvent, using the provided IngressStoppedEvent
func (*WSCallEvent) UnmarshalJSON ¶
func (t *WSCallEvent) UnmarshalJSON(b []byte) error
func (WSCallEvent) ValueByDiscriminator ¶
func (t WSCallEvent) ValueByDiscriminator() (interface{}, error)
type WebsocketEvent ¶
type WebsocketEvent interface {
GetEventType() string
}
WebsocketEvent is implemented by every event the coordinator websocket can deliver. The OpenAPI spec models those events as the VideoEvent union, which oapi-codegen renders as an opaque json.RawMessage wrapper; this interface is what lets callers type switch on the concrete event instead.
The GetEventType implementations live in wsevent_types.gen.go and are generated from the spec by internal/cmd/genwsevent.
func ParseWebsocketEvent ¶
func ParseWebsocketEvent(rawEvent []byte) (WebsocketEvent, error)
ParseWebsocketEvent decodes a raw websocket frame into the concrete event its "type" field names. Unknown event types are an error.