api.md

Shared

Types:

• PlaybackID
• PlaybackPolicy

Video

Assets

Types:

• Asset
• AssetOptions
• AssetResponse
• InputInfo
• Track
• AssetGenerateSubtitlesResponse
• AssetRetrieveInputInfoResponse

Methods:

• client.video.assets.create({ ...params }) -> Asset
• client.video.assets.retrieve(assetId) -> Asset
• client.video.assets.update(assetId, { ...params }) -> Asset
• client.video.assets.list({ ...params }) -> AssetsBasePage
• client.video.assets.delete(assetId) -> void
• client.video.assets.createPlaybackId(assetId, { ...params }) -> PlaybackID
• client.video.assets.createTrack(assetId, { ...params }) -> Track
• client.video.assets.deletePlaybackId(assetId, playbackId) -> void
• client.video.assets.deleteTrack(assetId, trackId) -> void
• client.video.assets.generateSubtitles(assetId, trackId, { ...params }) -> AssetGenerateSubtitlesResponse
• client.video.assets.retrieveInputInfo(assetId) -> AssetRetrieveInputInfoResponse
• client.video.assets.retrievePlaybackId(assetId, playbackId) -> PlaybackID
• client.video.assets.updateMasterAccess(assetId, { ...params }) -> Asset
• client.video.assets.updateMP4Support(assetId, { ...params }) -> Asset

DeliveryUsage

Types:

• DeliveryReport

Methods:

• client.video.deliveryUsage.list({ ...params }) -> DeliveryReportsPageWithTotal

LiveStreams

Types:

• LiveStream
• SimulcastTarget

Methods:

• client.video.liveStreams.create({ ...params }) -> LiveStream
• client.video.liveStreams.retrieve(liveStreamId) -> LiveStream
• client.video.liveStreams.update(liveStreamId, { ...params }) -> LiveStream
• client.video.liveStreams.list({ ...params }) -> LiveStreamsBasePage
• client.video.liveStreams.delete(liveStreamId) -> void
• client.video.liveStreams.complete(liveStreamId) -> void
• client.video.liveStreams.createPlaybackId(liveStreamId, { ...params }) -> PlaybackID
• client.video.liveStreams.createSimulcastTarget(liveStreamId, { ...params }) -> SimulcastTarget
• client.video.liveStreams.deletePlaybackId(liveStreamId, playbackId) -> void
• client.video.liveStreams.deleteSimulcastTarget(liveStreamId, simulcastTargetId) -> void
• client.video.liveStreams.disable(liveStreamId) -> void
• client.video.liveStreams.enable(liveStreamId) -> void
• client.video.liveStreams.resetStreamKey(liveStreamId) -> LiveStream
• client.video.liveStreams.retrievePlaybackId(liveStreamId, playbackId) -> PlaybackID
• client.video.liveStreams.retrieveSimulcastTarget(liveStreamId, simulcastTargetId) -> SimulcastTarget
• client.video.liveStreams.updateEmbeddedSubtitles(liveStreamId, { ...params }) -> LiveStream
• client.video.liveStreams.updateGeneratedSubtitles(liveStreamId, { ...params }) -> LiveStream

PlaybackIDs

Types:

• PlaybackIDRetrieveResponse

Methods:

• client.video.playbackIds.retrieve(playbackId) -> PlaybackIDRetrieveResponse

PlaybackRestrictions

Types:

• PlaybackRestriction
• PlaybackRestrictionResponse

Methods:

• client.video.playbackRestrictions.create({ ...params }) -> PlaybackRestriction
• client.video.playbackRestrictions.retrieve(playbackRestrictionId) -> PlaybackRestriction
• client.video.playbackRestrictions.list({ ...params }) -> PlaybackRestrictionsBasePage
• client.video.playbackRestrictions.delete(playbackRestrictionId) -> void
• client.video.playbackRestrictions.updateReferrer(playbackRestrictionId, { ...params }) -> PlaybackRestriction
• client.video.playbackRestrictions.updateUserAgent(playbackRestrictionId, { ...params }) -> PlaybackRestriction

Spaces

Types:

• Broadcast
• BroadcastLayout
• BroadcastResolution
• BroadcastResponse
• BroadcastStatus
• Space
• SpaceResponse
• SpaceStatus
• SpaceType

Methods:

• client.video.spaces.create({ ...params }) -> Space
• client.video.spaces.retrieve(spaceId) -> Space
• client.video.spaces.list({ ...params }) -> SpacesBasePage
• client.video.spaces.delete(spaceId) -> void
• client.video.spaces.createBroadcast(spaceId, { ...params }) -> Broadcast
• client.video.spaces.deleteBroadcast(spaceId, broadcastId) -> void
• client.video.spaces.retrieveBroadcast(spaceId, broadcastId) -> Broadcast
• client.video.spaces.startBroadcast(spaceId, broadcastId) -> void
• client.video.spaces.stopBroadcast(spaceId, broadcastId) -> void

TranscriptionVocabularies

Types:

• TranscriptionVocabulary
• TranscriptionVocabularyResponse

Methods:

• client.video.transcriptionVocabularies.create({ ...params }) -> TranscriptionVocabulary
• client.video.transcriptionVocabularies.retrieve(transcriptionVocabularyId) -> TranscriptionVocabulary
• client.video.transcriptionVocabularies.update(transcriptionVocabularyId, { ...params }) -> TranscriptionVocabulary
• client.video.transcriptionVocabularies.list({ ...params }) -> TranscriptionVocabulariesBasePage
• client.video.transcriptionVocabularies.delete(transcriptionVocabularyId) -> void

Uploads

Types:

• Upload
• UploadResponse

Methods:

• client.video.uploads.create({ ...params }) -> Upload
• client.video.uploads.retrieve(uploadId) -> Upload
• client.video.uploads.list({ ...params }) -> UploadsBasePage
• client.video.uploads.cancel(uploadId) -> Upload

WebInputs

Types:

• WebInputCreateResponse
• WebInputRetrieveResponse
• WebInputListResponse
• WebInputLaunchResponse
• WebInputReloadResponse
• WebInputShutdownResponse
• WebInputUpdateURLResponse

Methods:

• client.video.webInputs.create({ ...params }) -> WebInputCreateResponse
• client.video.webInputs.retrieve(webInputId) -> WebInputRetrieveResponse
• client.video.webInputs.list({ ...params }) -> WebInputListResponsesBasePage
• client.video.webInputs.delete(webInputId) -> void
• client.video.webInputs.launch(webInputId) -> WebInputLaunchResponse
• client.video.webInputs.reload(webInputId) -> WebInputReloadResponse
• client.video.webInputs.shutdown(webInputId) -> WebInputShutdownResponse
• client.video.webInputs.updateURL(webInputId, { ...params }) -> WebInputUpdateURLResponse

Data

Dimensions

Types:

• DimensionValue
• DimensionsResponse

Methods:

• client.data.dimensions.list() -> DimensionsResponse
• client.data.dimensions.listValues(dimensionId, { ...params }) -> DimensionValuesBasePage

Monitoring

Types:

• MonitoringListDimensionsResponse

Methods:

• client.data.monitoring.listDimensions() -> MonitoringListDimensionsResponse

Metrics

Types:

• MetricListResponse
• MetricGetBreakdownResponse
• MetricGetBreakdownTimeseriesResponse
• MetricGetHistogramTimeseriesResponse
• MetricGetTimeseriesResponse

Methods:

• client.data.monitoring.metrics.list() -> MetricListResponse
• client.data.monitoring.metrics.getBreakdown(monitoringMetricId, { ...params }) -> MetricGetBreakdownResponse
• client.data.monitoring.metrics.getBreakdownTimeseries(monitoringMetricId, { ...params }) -> MetricGetBreakdownTimeseriesResponse
• client.data.monitoring.metrics.getHistogramTimeseries(monitoringHistogramMetricId, { ...params }) -> MetricGetHistogramTimeseriesResponse
• client.data.monitoring.metrics.getTimeseries(monitoringMetricId, { ...params }) -> MetricGetTimeseriesResponse

Errors

Types:

• ErrorsResponse

Methods:

• client.data.errors.list({ ...params }) -> ErrorsResponse

Exports

Types:

• ExportsResponse
• VideoViewExportsResponse

Methods:

• client.data.exports.listVideoViews() -> VideoViewExportsResponse

Filters

Types:

• FilterValue
• FiltersResponse

Methods:

• client.data.filters.listValues(filterId, { ...params }) -> FilterValuesBasePage

Incidents

Types:

• Incident
• IncidentResponse

Methods:

• client.data.incidents.retrieve(incidentId) -> IncidentResponse
• client.data.incidents.list({ ...params }) -> IncidentsBasePage
• client.data.incidents.listRelated(incidentId, { ...params }) -> IncidentsBasePage

Metrics

Types:

• AllMetricValuesResponse
• BreakdownValue
• InsightsResponse
• MetricTimeseriesDataResponse
• OverallValuesResponse

Methods:

• client.data.metrics.list({ ...params }) -> AllMetricValuesResponse
• client.data.metrics.getInsights(metricId, { ...params }) -> InsightsResponse
• client.data.metrics.getOverallValues(metricId, { ...params }) -> OverallValuesResponse
• client.data.metrics.getTimeseries(metricId, { ...params }) -> MetricTimeseriesDataResponse
• client.data.metrics.listBreakdownValues(metricId, { ...params }) -> BreakdownValuesBasePage

RealTime

Types:

• RealTimeBreakdownResponse
• RealTimeDimensionsResponse
• RealTimeHistogramTimeseriesResponse
• RealTimeMetricsResponse
• RealTimeTimeseriesResponse

Methods:

• client.data.realTime.listDimensions() -> RealTimeDimensionsResponse
• client.data.realTime.listMetrics() -> RealTimeMetricsResponse
• client.data.realTime.retrieveBreakdown(realtimeMetricId, { ...params }) -> RealTimeBreakdownResponse
• client.data.realTime.retrieveHistogramTimeseries(realtimeHistogramMetricId, { ...params }) -> RealTimeHistogramTimeseriesResponse
• client.data.realTime.retrieveTimeseries(realtimeMetricId, { ...params }) -> RealTimeTimeseriesResponse

VideoViews

Types:

• AbridgedVideoView
• VideoViewResponse

Methods:

• client.data.videoViews.retrieve(videoViewId) -> VideoViewResponse
• client.data.videoViews.list({ ...params }) -> AbridgedVideoViewsBasePage

System

SigningKeys

Types:

• SigningKey
• SigningKeyResponse

Methods:

• client.system.signingKeys.create() -> SigningKey
• client.system.signingKeys.retrieve(signingKeyId) -> SigningKey
• client.system.signingKeys.list({ ...params }) -> SigningKeysBasePage
• client.system.signingKeys.delete(signingKeyId) -> void

Webhooks

Types:

• BaseWebhookEvent
• VideoAssetCreatedWebhookEvent
• VideoAssetReadyWebhookEvent
• VideoAssetErroredWebhookEvent
• VideoAssetUpdatedWebhookEvent
• VideoAssetDeletedWebhookEvent
• VideoAssetLiveStreamCompletedWebhookEvent
• VideoAssetStaticRenditionsReadyWebhookEvent
• VideoAssetStaticRenditionsPreparingWebhookEvent
• VideoAssetStaticRenditionsDeletedWebhookEvent
• VideoAssetStaticRenditionsErroredWebhookEvent
• VideoAssetMasterReadyWebhookEvent
• VideoAssetMasterPreparingWebhookEvent
• VideoAssetMasterDeletedWebhookEvent
• VideoAssetMasterErroredWebhookEvent
• VideoAssetTrackCreatedWebhookEvent
• VideoAssetTrackReadyWebhookEvent
• VideoAssetTrackErroredWebhookEvent
• VideoAssetTrackDeletedWebhookEvent
• VideoAssetWarningWebhookEvent
• VideoUploadAssetCreatedWebhookEvent
• VideoUploadCancelledWebhookEvent
• VideoUploadCreatedWebhookEvent
• VideoUploadErroredWebhookEvent
• VideoLiveStreamCreatedWebhookEvent
• VideoLiveStreamConnectedWebhookEvent
• VideoLiveStreamRecordingWebhookEvent
• VideoLiveStreamActiveWebhookEvent
• VideoLiveStreamDisconnectedWebhookEvent
• VideoLiveStreamIdleWebhookEvent
• VideoLiveStreamUpdatedWebhookEvent
• VideoLiveStreamEnabledWebhookEvent
• VideoLiveStreamDisabledWebhookEvent
• VideoLiveStreamDeletedWebhookEvent
• VideoLiveStreamWarningWebhookEvent
• VideoLiveStreamSimulcastTargetCreatedWebhookEvent
• VideoLiveStreamSimulcastTargetIdleWebhookEvent
• VideoLiveStreamSimulcastTargetStartingWebhookEvent
• VideoLiveStreamSimulcastTargetBroadcastingWebhookEvent
• VideoLiveStreamSimulcastTargetErroredWebhookEvent
• VideoLiveStreamSimulcastTargetDeletedWebhookEvent
• VideoLiveStreamSimulcastTargetUpdatedWebhookEvent
• VideoSpaceCreatedWebhookEvent
• VideoSpaceDeletedWebhookEvent
• VideoSpaceActiveWebhookEvent
• VideoSpaceIdleWebhookEvent
• VideoSpaceUpdatedWebhookEvent
• VideoSpaceBroadcastCreatedWebhookEvent
• VideoSpaceBroadcastIdleWebhookEvent
• VideoSpaceBroadcastActiveWebhookEvent
• VideoSpaceBroadcastDeletedWebhookEvent
• VideoDeliveryHighTrafficWebhookEvent
• UnwrapWebhookEvent

Methods:

• client.webhooks.unwrap(body, headers, secret) -> UnwrapWebhookEvent
• client.webhooks.verifySignature(body, headers, secret) -> void

Jwt

Methods:

• client.jwt.signPlaybackId(playbackId, config) -> Promise<string>
• client.jwt.signSpaceId(spaceId, config) -> Promise<string>
• client.jwt.signViewerCounts(id, config) -> Promise<string>