@fastpix/fastpix-node 2.0.4 → 2.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +1 -1
- package/README.md +11 -11
- package/dist/commonjs/funcs/aiFeaturesGenerateNamedEntities.d.ts +2 -2
- package/dist/commonjs/funcs/aiFeaturesGenerateNamedEntities.js +2 -2
- package/dist/commonjs/funcs/aiFeaturesUpdateSummary.d.ts +2 -2
- package/dist/commonjs/funcs/aiFeaturesUpdateSummary.js +2 -2
- package/dist/commonjs/funcs/dimensionsList.d.ts +2 -2
- package/dist/commonjs/funcs/dimensionsList.js +2 -2
- package/dist/commonjs/funcs/dimensionsListFilterValues.d.ts +2 -2
- package/dist/commonjs/funcs/dimensionsListFilterValues.js +2 -2
- package/dist/commonjs/funcs/drmConfigurationsGet.d.ts +1 -1
- package/dist/commonjs/funcs/drmConfigurationsGet.js +1 -1
- package/dist/commonjs/funcs/drmConfigurationsList.d.ts +1 -1
- package/dist/commonjs/funcs/drmConfigurationsList.js +1 -1
- package/dist/commonjs/funcs/errorsList.d.ts +1 -1
- package/dist/commonjs/funcs/errorsList.js +1 -1
- package/dist/commonjs/funcs/inVideoAIUpdateModeration.d.ts +2 -2
- package/dist/commonjs/funcs/inVideoAIUpdateModeration.js +2 -2
- package/dist/commonjs/funcs/inVideoAIfeaturesGenerateChapters.d.ts +2 -2
- package/dist/commonjs/funcs/inVideoAIfeaturesGenerateChapters.js +2 -2
- package/dist/commonjs/funcs/inputVideoCreate.d.ts +4 -4
- package/dist/commonjs/funcs/inputVideoCreate.js +4 -4
- package/dist/commonjs/funcs/inputVideoUpload.d.ts +5 -5
- package/dist/commonjs/funcs/inputVideoUpload.js +5 -5
- package/dist/commonjs/funcs/liveStreamsCreate.d.ts +3 -3
- package/dist/commonjs/funcs/liveStreamsCreate.js +3 -3
- package/dist/commonjs/funcs/liveStreamsDelete.d.ts +2 -2
- package/dist/commonjs/funcs/liveStreamsDelete.js +2 -2
- package/dist/commonjs/funcs/liveStreamsEnable.d.ts +1 -1
- package/dist/commonjs/funcs/liveStreamsEnable.js +1 -1
- package/dist/commonjs/funcs/liveStreamsListClips.d.ts +1 -1
- package/dist/commonjs/funcs/liveStreamsListClips.js +1 -1
- package/dist/commonjs/funcs/manageLiveStreamComplete.d.ts +1 -1
- package/dist/commonjs/funcs/manageLiveStreamComplete.js +1 -1
- package/dist/commonjs/funcs/manageLiveStreamDisable.d.ts +1 -1
- package/dist/commonjs/funcs/manageLiveStreamDisable.js +1 -1
- package/dist/commonjs/funcs/manageLiveStreamGet.d.ts +1 -1
- package/dist/commonjs/funcs/manageLiveStreamGet.js +1 -1
- package/dist/commonjs/funcs/manageLiveStreamGetViewerCount.d.ts +1 -1
- package/dist/commonjs/funcs/manageLiveStreamGetViewerCount.js +1 -1
- package/dist/commonjs/funcs/manageLiveStreamUpdate.d.ts +2 -2
- package/dist/commonjs/funcs/manageLiveStreamUpdate.js +2 -2
- package/dist/commonjs/funcs/manageVideosAddTrack.d.ts +5 -5
- package/dist/commonjs/funcs/manageVideosAddTrack.js +5 -5
- package/dist/commonjs/funcs/manageVideosCancelUpload.d.ts +1 -1
- package/dist/commonjs/funcs/manageVideosCancelUpload.js +1 -1
- package/dist/commonjs/funcs/manageVideosDelete.d.ts +1 -1
- package/dist/commonjs/funcs/manageVideosDelete.js +1 -1
- package/dist/commonjs/funcs/manageVideosGenerateSubtitleTrack.d.ts +3 -3
- package/dist/commonjs/funcs/manageVideosGenerateSubtitleTrack.js +3 -3
- package/dist/commonjs/funcs/manageVideosGet.d.ts +1 -1
- package/dist/commonjs/funcs/manageVideosGet.js +1 -1
- package/dist/commonjs/funcs/manageVideosUpdate.d.ts +1 -1
- package/dist/commonjs/funcs/manageVideosUpdate.js +1 -1
- package/dist/commonjs/funcs/manageVideosUpdateMp4Support.d.ts +3 -3
- package/dist/commonjs/funcs/manageVideosUpdateMp4Support.js +3 -3
- package/dist/commonjs/funcs/manageVideosUpdateTrack.d.ts +4 -4
- package/dist/commonjs/funcs/manageVideosUpdateTrack.js +4 -4
- package/dist/commonjs/funcs/mediaDeleteTrack.d.ts +2 -2
- package/dist/commonjs/funcs/mediaDeleteTrack.js +2 -2
- package/dist/commonjs/funcs/mediaGetClips.d.ts +1 -1
- package/dist/commonjs/funcs/mediaGetClips.js +1 -1
- package/dist/commonjs/funcs/mediaUpdateSourceAccess.d.ts +1 -1
- package/dist/commonjs/funcs/mediaUpdateSourceAccess.js +1 -1
- package/dist/commonjs/funcs/metricsListBreakdownValues.d.ts +2 -2
- package/dist/commonjs/funcs/metricsListBreakdownValues.js +2 -2
- package/dist/commonjs/funcs/metricsListCompares.d.ts +2 -2
- package/dist/commonjs/funcs/metricsListCompares.js +2 -2
- package/dist/commonjs/funcs/metricsListOverallValues.d.ts +2 -2
- package/dist/commonjs/funcs/metricsListOverallValues.js +2 -2
- package/dist/commonjs/funcs/playbackCreate.d.ts +1 -1
- package/dist/commonjs/funcs/playbackCreate.js +1 -1
- package/dist/commonjs/funcs/playlistCreate.d.ts +1 -1
- package/dist/commonjs/funcs/playlistCreate.js +1 -1
- package/dist/commonjs/funcs/signingKeysCreate.d.ts +1 -1
- package/dist/commonjs/funcs/signingKeysCreate.js +1 -1
- package/dist/commonjs/funcs/signingKeysGetById.d.ts +2 -2
- package/dist/commonjs/funcs/signingKeysGetById.js +2 -2
- package/dist/commonjs/funcs/simulcastStreamsDelete.d.ts +1 -1
- package/dist/commonjs/funcs/simulcastStreamsDelete.js +1 -1
- package/dist/commonjs/funcs/simulcastsCreate.d.ts +2 -2
- package/dist/commonjs/funcs/simulcastsCreate.js +2 -2
- package/dist/commonjs/funcs/simulcastsUpdate.d.ts +1 -1
- package/dist/commonjs/funcs/simulcastsUpdate.js +1 -1
- package/dist/commonjs/funcs/viewsGetDetails.d.ts +1 -1
- package/dist/commonjs/funcs/viewsGetDetails.js +1 -1
- package/dist/commonjs/funcs/viewsList.d.ts +3 -3
- package/dist/commonjs/funcs/viewsList.js +3 -3
- package/dist/commonjs/funcs/viewsListTopContent.d.ts +1 -1
- package/dist/commonjs/funcs/viewsListTopContent.js +1 -1
- package/dist/commonjs/hooks/eventsFieldRemapHook.d.ts +5 -0
- package/dist/commonjs/hooks/eventsFieldRemapHook.d.ts.map +1 -0
- package/dist/commonjs/hooks/eventsFieldRemapHook.js +84 -0
- package/dist/commonjs/hooks/eventsFieldRemapHook.js.map +1 -0
- package/dist/commonjs/hooks/registration.d.ts.map +1 -1
- package/dist/commonjs/hooks/registration.js +2 -4
- package/dist/commonjs/hooks/registration.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.d.ts.map +1 -1
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/models/addtrackrequest.js +1 -1
- package/dist/commonjs/models/addtrackrequest.js.map +1 -1
- package/dist/commonjs/models/createmediarequest.d.ts +1 -1
- package/dist/commonjs/models/deletesigningkeyresponse.d.ts +10 -0
- package/dist/commonjs/models/deletesigningkeyresponse.d.ts.map +1 -1
- package/dist/commonjs/models/deletesigningkeyresponse.js +1 -0
- package/dist/commonjs/models/deletesigningkeyresponse.js.map +1 -1
- package/dist/commonjs/models/operations/directuploadvideomedia.d.ts +2 -2
- package/dist/commonjs/models/pullvideoinput.js +1 -1
- package/dist/commonjs/models/pullvideoinput.js.map +1 -1
- package/dist/commonjs/models/videotrackforgetall.d.ts +4 -0
- package/dist/commonjs/models/videotrackforgetall.d.ts.map +1 -1
- package/dist/commonjs/models/videotrackforgetall.js +1 -0
- package/dist/commonjs/models/videotrackforgetall.js.map +1 -1
- package/dist/commonjs/models/views.d.ts +3 -3
- package/dist/commonjs/models/views.d.ts.map +1 -1
- package/dist/commonjs/models/views.js +4 -9
- package/dist/commonjs/models/views.js.map +1 -1
- package/dist/commonjs/models/viewslist.d.ts +7 -1
- package/dist/commonjs/models/viewslist.d.ts.map +1 -1
- package/dist/commonjs/models/viewslist.js +3 -7
- package/dist/commonjs/models/viewslist.js.map +1 -1
- package/dist/commonjs/models/watermarkinput.d.ts +1 -1
- package/dist/commonjs/sdk/aifeatures.d.ts +4 -4
- package/dist/commonjs/sdk/aifeatures.js +4 -4
- package/dist/commonjs/sdk/dimensions.d.ts +4 -4
- package/dist/commonjs/sdk/dimensions.js +4 -4
- package/dist/commonjs/sdk/drmconfigurations.d.ts +2 -2
- package/dist/commonjs/sdk/drmconfigurations.js +2 -2
- package/dist/commonjs/sdk/errors.d.ts +1 -1
- package/dist/commonjs/sdk/errors.js +1 -1
- package/dist/commonjs/sdk/inputvideo.d.ts +9 -9
- package/dist/commonjs/sdk/inputvideo.js +9 -9
- package/dist/commonjs/sdk/invideoai.d.ts +2 -2
- package/dist/commonjs/sdk/invideoai.js +2 -2
- package/dist/commonjs/sdk/invideoaifeatures.d.ts +2 -2
- package/dist/commonjs/sdk/invideoaifeatures.js +2 -2
- package/dist/commonjs/sdk/livestreams.d.ts +7 -7
- package/dist/commonjs/sdk/livestreams.js +7 -7
- package/dist/commonjs/sdk/managelivestream.d.ts +6 -6
- package/dist/commonjs/sdk/managelivestream.js +6 -6
- package/dist/commonjs/sdk/managevideos.d.ts +19 -19
- package/dist/commonjs/sdk/managevideos.js +19 -19
- package/dist/commonjs/sdk/media.d.ts +4 -4
- package/dist/commonjs/sdk/media.js +4 -4
- package/dist/commonjs/sdk/metrics.d.ts +6 -6
- package/dist/commonjs/sdk/metrics.js +6 -6
- package/dist/commonjs/sdk/playback.d.ts +1 -1
- package/dist/commonjs/sdk/playback.js +1 -1
- package/dist/commonjs/sdk/playlist.d.ts +1 -1
- package/dist/commonjs/sdk/playlist.js +1 -1
- package/dist/commonjs/sdk/signingkeys.d.ts +3 -3
- package/dist/commonjs/sdk/signingkeys.js +3 -3
- package/dist/commonjs/sdk/simulcasts.d.ts +3 -3
- package/dist/commonjs/sdk/simulcasts.js +3 -3
- package/dist/commonjs/sdk/simulcaststreams.d.ts +1 -1
- package/dist/commonjs/sdk/simulcaststreams.js +1 -1
- package/dist/commonjs/sdk/views.d.ts +5 -5
- package/dist/commonjs/sdk/views.js +5 -5
- package/dist/esm/funcs/aiFeaturesGenerateNamedEntities.d.ts +2 -2
- package/dist/esm/funcs/aiFeaturesGenerateNamedEntities.js +2 -2
- package/dist/esm/funcs/aiFeaturesUpdateSummary.d.ts +2 -2
- package/dist/esm/funcs/aiFeaturesUpdateSummary.js +2 -2
- package/dist/esm/funcs/dimensionsList.d.ts +2 -2
- package/dist/esm/funcs/dimensionsList.js +2 -2
- package/dist/esm/funcs/dimensionsListFilterValues.d.ts +2 -2
- package/dist/esm/funcs/dimensionsListFilterValues.js +2 -2
- package/dist/esm/funcs/drmConfigurationsGet.d.ts +1 -1
- package/dist/esm/funcs/drmConfigurationsGet.js +1 -1
- package/dist/esm/funcs/drmConfigurationsList.d.ts +1 -1
- package/dist/esm/funcs/drmConfigurationsList.js +1 -1
- package/dist/esm/funcs/errorsList.d.ts +1 -1
- package/dist/esm/funcs/errorsList.js +1 -1
- package/dist/esm/funcs/inVideoAIUpdateModeration.d.ts +2 -2
- package/dist/esm/funcs/inVideoAIUpdateModeration.js +2 -2
- package/dist/esm/funcs/inVideoAIfeaturesGenerateChapters.d.ts +2 -2
- package/dist/esm/funcs/inVideoAIfeaturesGenerateChapters.js +2 -2
- package/dist/esm/funcs/inputVideoCreate.d.ts +4 -4
- package/dist/esm/funcs/inputVideoCreate.js +4 -4
- package/dist/esm/funcs/inputVideoUpload.d.ts +5 -5
- package/dist/esm/funcs/inputVideoUpload.js +5 -5
- package/dist/esm/funcs/liveStreamsCreate.d.ts +3 -3
- package/dist/esm/funcs/liveStreamsCreate.js +3 -3
- package/dist/esm/funcs/liveStreamsDelete.d.ts +2 -2
- package/dist/esm/funcs/liveStreamsDelete.js +2 -2
- package/dist/esm/funcs/liveStreamsEnable.d.ts +1 -1
- package/dist/esm/funcs/liveStreamsEnable.js +1 -1
- package/dist/esm/funcs/liveStreamsListClips.d.ts +1 -1
- package/dist/esm/funcs/liveStreamsListClips.js +1 -1
- package/dist/esm/funcs/manageLiveStreamComplete.d.ts +1 -1
- package/dist/esm/funcs/manageLiveStreamComplete.js +1 -1
- package/dist/esm/funcs/manageLiveStreamDisable.d.ts +1 -1
- package/dist/esm/funcs/manageLiveStreamDisable.js +1 -1
- package/dist/esm/funcs/manageLiveStreamGet.d.ts +1 -1
- package/dist/esm/funcs/manageLiveStreamGet.js +1 -1
- package/dist/esm/funcs/manageLiveStreamGetViewerCount.d.ts +1 -1
- package/dist/esm/funcs/manageLiveStreamGetViewerCount.js +1 -1
- package/dist/esm/funcs/manageLiveStreamUpdate.d.ts +2 -2
- package/dist/esm/funcs/manageLiveStreamUpdate.js +2 -2
- package/dist/esm/funcs/manageVideosAddTrack.d.ts +5 -5
- package/dist/esm/funcs/manageVideosAddTrack.js +5 -5
- package/dist/esm/funcs/manageVideosCancelUpload.d.ts +1 -1
- package/dist/esm/funcs/manageVideosCancelUpload.js +1 -1
- package/dist/esm/funcs/manageVideosDelete.d.ts +1 -1
- package/dist/esm/funcs/manageVideosDelete.js +1 -1
- package/dist/esm/funcs/manageVideosGenerateSubtitleTrack.d.ts +3 -3
- package/dist/esm/funcs/manageVideosGenerateSubtitleTrack.js +3 -3
- package/dist/esm/funcs/manageVideosGet.d.ts +1 -1
- package/dist/esm/funcs/manageVideosGet.js +1 -1
- package/dist/esm/funcs/manageVideosUpdate.d.ts +1 -1
- package/dist/esm/funcs/manageVideosUpdate.js +1 -1
- package/dist/esm/funcs/manageVideosUpdateMp4Support.d.ts +3 -3
- package/dist/esm/funcs/manageVideosUpdateMp4Support.js +3 -3
- package/dist/esm/funcs/manageVideosUpdateTrack.d.ts +4 -4
- package/dist/esm/funcs/manageVideosUpdateTrack.js +4 -4
- package/dist/esm/funcs/mediaDeleteTrack.d.ts +2 -2
- package/dist/esm/funcs/mediaDeleteTrack.js +2 -2
- package/dist/esm/funcs/mediaGetClips.d.ts +1 -1
- package/dist/esm/funcs/mediaGetClips.js +1 -1
- package/dist/esm/funcs/mediaUpdateSourceAccess.d.ts +1 -1
- package/dist/esm/funcs/mediaUpdateSourceAccess.js +1 -1
- package/dist/esm/funcs/metricsListBreakdownValues.d.ts +2 -2
- package/dist/esm/funcs/metricsListBreakdownValues.js +2 -2
- package/dist/esm/funcs/metricsListCompares.d.ts +2 -2
- package/dist/esm/funcs/metricsListCompares.js +2 -2
- package/dist/esm/funcs/metricsListOverallValues.d.ts +2 -2
- package/dist/esm/funcs/metricsListOverallValues.js +2 -2
- package/dist/esm/funcs/playbackCreate.d.ts +1 -1
- package/dist/esm/funcs/playbackCreate.js +1 -1
- package/dist/esm/funcs/playlistCreate.d.ts +1 -1
- package/dist/esm/funcs/playlistCreate.js +1 -1
- package/dist/esm/funcs/signingKeysCreate.d.ts +1 -1
- package/dist/esm/funcs/signingKeysCreate.js +1 -1
- package/dist/esm/funcs/signingKeysGetById.d.ts +2 -2
- package/dist/esm/funcs/signingKeysGetById.js +2 -2
- package/dist/esm/funcs/simulcastStreamsDelete.d.ts +1 -1
- package/dist/esm/funcs/simulcastStreamsDelete.js +1 -1
- package/dist/esm/funcs/simulcastsCreate.d.ts +2 -2
- package/dist/esm/funcs/simulcastsCreate.js +2 -2
- package/dist/esm/funcs/simulcastsUpdate.d.ts +1 -1
- package/dist/esm/funcs/simulcastsUpdate.js +1 -1
- package/dist/esm/funcs/viewsGetDetails.d.ts +1 -1
- package/dist/esm/funcs/viewsGetDetails.js +1 -1
- package/dist/esm/funcs/viewsList.d.ts +3 -3
- package/dist/esm/funcs/viewsList.js +3 -3
- package/dist/esm/funcs/viewsListTopContent.d.ts +1 -1
- package/dist/esm/funcs/viewsListTopContent.js +1 -1
- package/dist/esm/hooks/eventsFieldRemapHook.d.ts +5 -0
- package/dist/esm/hooks/eventsFieldRemapHook.d.ts.map +1 -0
- package/dist/esm/hooks/eventsFieldRemapHook.js +80 -0
- package/dist/esm/hooks/eventsFieldRemapHook.js.map +1 -0
- package/dist/esm/hooks/registration.d.ts.map +1 -1
- package/dist/esm/hooks/registration.js +2 -4
- package/dist/esm/hooks/registration.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.d.ts.map +1 -1
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/models/addtrackrequest.js +1 -1
- package/dist/esm/models/addtrackrequest.js.map +1 -1
- package/dist/esm/models/createmediarequest.d.ts +1 -1
- package/dist/esm/models/deletesigningkeyresponse.d.ts +10 -0
- package/dist/esm/models/deletesigningkeyresponse.d.ts.map +1 -1
- package/dist/esm/models/deletesigningkeyresponse.js +1 -0
- package/dist/esm/models/deletesigningkeyresponse.js.map +1 -1
- package/dist/esm/models/operations/directuploadvideomedia.d.ts +2 -2
- package/dist/esm/models/pullvideoinput.js +1 -1
- package/dist/esm/models/pullvideoinput.js.map +1 -1
- package/dist/esm/models/videotrackforgetall.d.ts +4 -0
- package/dist/esm/models/videotrackforgetall.d.ts.map +1 -1
- package/dist/esm/models/videotrackforgetall.js +1 -0
- package/dist/esm/models/videotrackforgetall.js.map +1 -1
- package/dist/esm/models/views.d.ts +3 -3
- package/dist/esm/models/views.d.ts.map +1 -1
- package/dist/esm/models/views.js +4 -9
- package/dist/esm/models/views.js.map +1 -1
- package/dist/esm/models/viewslist.d.ts +7 -1
- package/dist/esm/models/viewslist.d.ts.map +1 -1
- package/dist/esm/models/viewslist.js +3 -7
- package/dist/esm/models/viewslist.js.map +1 -1
- package/dist/esm/models/watermarkinput.d.ts +1 -1
- package/dist/esm/sdk/aifeatures.d.ts +4 -4
- package/dist/esm/sdk/aifeatures.js +4 -4
- package/dist/esm/sdk/dimensions.d.ts +4 -4
- package/dist/esm/sdk/dimensions.js +4 -4
- package/dist/esm/sdk/drmconfigurations.d.ts +2 -2
- package/dist/esm/sdk/drmconfigurations.js +2 -2
- package/dist/esm/sdk/errors.d.ts +1 -1
- package/dist/esm/sdk/errors.js +1 -1
- package/dist/esm/sdk/inputvideo.d.ts +9 -9
- package/dist/esm/sdk/inputvideo.js +9 -9
- package/dist/esm/sdk/invideoai.d.ts +2 -2
- package/dist/esm/sdk/invideoai.js +2 -2
- package/dist/esm/sdk/invideoaifeatures.d.ts +2 -2
- package/dist/esm/sdk/invideoaifeatures.js +2 -2
- package/dist/esm/sdk/livestreams.d.ts +7 -7
- package/dist/esm/sdk/livestreams.js +7 -7
- package/dist/esm/sdk/managelivestream.d.ts +6 -6
- package/dist/esm/sdk/managelivestream.js +6 -6
- package/dist/esm/sdk/managevideos.d.ts +19 -19
- package/dist/esm/sdk/managevideos.js +19 -19
- package/dist/esm/sdk/media.d.ts +4 -4
- package/dist/esm/sdk/media.js +4 -4
- package/dist/esm/sdk/metrics.d.ts +6 -6
- package/dist/esm/sdk/metrics.js +6 -6
- package/dist/esm/sdk/playback.d.ts +1 -1
- package/dist/esm/sdk/playback.js +1 -1
- package/dist/esm/sdk/playlist.d.ts +1 -1
- package/dist/esm/sdk/playlist.js +1 -1
- package/dist/esm/sdk/signingkeys.d.ts +3 -3
- package/dist/esm/sdk/signingkeys.js +3 -3
- package/dist/esm/sdk/simulcasts.d.ts +3 -3
- package/dist/esm/sdk/simulcasts.js +3 -3
- package/dist/esm/sdk/simulcaststreams.d.ts +1 -1
- package/dist/esm/sdk/simulcaststreams.js +1 -1
- package/dist/esm/sdk/views.d.ts +5 -5
- package/dist/esm/sdk/views.js +5 -5
- package/examples/inputVideoCreate.example.ts +1 -1
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +10 -4
- package/src/funcs/aiFeaturesGenerateNamedEntities.ts +2 -2
- package/src/funcs/aiFeaturesUpdateSummary.ts +2 -2
- package/src/funcs/dimensionsList.ts +2 -2
- package/src/funcs/dimensionsListFilterValues.ts +2 -2
- package/src/funcs/drmConfigurationsGet.ts +1 -1
- package/src/funcs/drmConfigurationsList.ts +1 -1
- package/src/funcs/errorsList.ts +1 -1
- package/src/funcs/inVideoAIUpdateModeration.ts +2 -2
- package/src/funcs/inVideoAIfeaturesGenerateChapters.ts +2 -2
- package/src/funcs/inputVideoCreate.ts +4 -4
- package/src/funcs/inputVideoUpload.ts +5 -5
- package/src/funcs/liveStreamsCreate.ts +3 -3
- package/src/funcs/liveStreamsDelete.ts +2 -2
- package/src/funcs/liveStreamsEnable.ts +1 -1
- package/src/funcs/liveStreamsListClips.ts +1 -1
- package/src/funcs/manageLiveStreamComplete.ts +1 -1
- package/src/funcs/manageLiveStreamDisable.ts +1 -1
- package/src/funcs/manageLiveStreamGet.ts +1 -1
- package/src/funcs/manageLiveStreamGetViewerCount.ts +1 -1
- package/src/funcs/manageLiveStreamUpdate.ts +2 -2
- package/src/funcs/manageVideosAddTrack.ts +5 -5
- package/src/funcs/manageVideosCancelUpload.ts +1 -1
- package/src/funcs/manageVideosDelete.ts +1 -1
- package/src/funcs/manageVideosGenerateSubtitleTrack.ts +3 -3
- package/src/funcs/manageVideosGet.ts +1 -1
- package/src/funcs/manageVideosUpdate.ts +1 -1
- package/src/funcs/manageVideosUpdateMp4Support.ts +3 -3
- package/src/funcs/manageVideosUpdateTrack.ts +4 -4
- package/src/funcs/mediaDeleteTrack.ts +2 -2
- package/src/funcs/mediaGetClips.ts +1 -1
- package/src/funcs/mediaUpdateSourceAccess.ts +1 -1
- package/src/funcs/metricsListBreakdownValues.ts +2 -2
- package/src/funcs/metricsListCompares.ts +2 -2
- package/src/funcs/metricsListOverallValues.ts +2 -2
- package/src/funcs/playbackCreate.ts +1 -1
- package/src/funcs/playlistCreate.ts +1 -1
- package/src/funcs/signingKeysCreate.ts +1 -1
- package/src/funcs/signingKeysGetById.ts +2 -2
- package/src/funcs/simulcastStreamsDelete.ts +1 -1
- package/src/funcs/simulcastsCreate.ts +2 -2
- package/src/funcs/simulcastsUpdate.ts +1 -1
- package/src/funcs/viewsGetDetails.ts +1 -1
- package/src/funcs/viewsList.ts +3 -3
- package/src/funcs/viewsListTopContent.ts +1 -1
- package/src/hooks/eventsFieldRemapHook.ts +94 -0
- package/src/hooks/registration.ts +2 -4
- package/src/lib/config.ts +3 -3
- package/src/models/addtrackrequest.ts +1 -1
- package/src/models/createmediarequest.ts +1 -1
- package/src/models/deletesigningkeyresponse.ts +14 -0
- package/src/models/operations/directuploadvideomedia.ts +2 -2
- package/src/models/pullvideoinput.ts +1 -1
- package/src/models/videotrackforgetall.ts +5 -0
- package/src/models/views.ts +7 -19
- package/src/models/viewslist.ts +21 -22
- package/src/models/watermarkinput.ts +1 -1
- package/src/sdk/aifeatures.ts +4 -4
- package/src/sdk/dimensions.ts +4 -4
- package/src/sdk/drmconfigurations.ts +2 -2
- package/src/sdk/errors.ts +1 -1
- package/src/sdk/inputvideo.ts +9 -9
- package/src/sdk/invideoai.ts +2 -2
- package/src/sdk/invideoaifeatures.ts +2 -2
- package/src/sdk/livestreams.ts +7 -7
- package/src/sdk/managelivestream.ts +6 -6
- package/src/sdk/managevideos.ts +19 -19
- package/src/sdk/media.ts +4 -4
- package/src/sdk/metrics.ts +6 -6
- package/src/sdk/playback.ts +1 -1
- package/src/sdk/playlist.ts +1 -1
- package/src/sdk/signingkeys.ts +3 -3
- package/src/sdk/simulcasts.ts +3 -3
- package/src/sdk/simulcaststreams.ts +1 -1
- package/src/sdk/views.ts +5 -5
- package/tests/artifacts/get-all-playlists.api.json +26 -0
- package/tests/artifacts/get-all-playlists.sdk.json +26 -0
- package/tests/artifacts/get-all-streams.api.json +76 -0
- package/tests/artifacts/get-all-streams.sdk.json +76 -0
- package/tests/artifacts/get-live-stream-by-id.api.json +43 -0
- package/tests/artifacts/get-live-stream-by-id.sdk.json +43 -0
- package/tests/artifacts/get-live-stream-playback-id.api.json +7 -0
- package/tests/artifacts/get-live-stream-playback-id.sdk.json +7 -0
- package/tests/artifacts/get-live-stream-viewer-count-by-id.api.json +6 -0
- package/tests/artifacts/get-live-stream-viewer-count-by-id.sdk.json +6 -0
- package/tests/artifacts/get-media-clips.api.json +9 -0
- package/tests/artifacts/get-media-clips.sdk.json +9 -0
- package/tests/artifacts/get-media-summary.api.json +8 -0
- package/tests/artifacts/get-media-summary.sdk.json +26 -0
- package/tests/artifacts/get-media.api.json +57 -0
- package/tests/artifacts/get-media.sdk.json +57 -0
- package/tests/artifacts/get-playback-id.api.json +19 -0
- package/tests/artifacts/get-playback-id.sdk.json +19 -0
- package/tests/artifacts/get-playlist-by-id.api.json +15 -0
- package/tests/artifacts/get-playlist-by-id.sdk.json +15 -0
- package/tests/artifacts/get-signing_key_by_id.api.json +8 -0
- package/tests/artifacts/get-signing_key_by_id.sdk.json +8 -0
- package/tests/artifacts/get-specific-simulcast-of-stream.api.json +12 -0
- package/tests/artifacts/get-specific-simulcast-of-stream.sdk.json +12 -0
- package/tests/artifacts/getDrmConfiguration.api.json +8 -0
- package/tests/artifacts/getDrmConfiguration.sdk.json +26 -0
- package/tests/artifacts/getDrmConfigurationById.api.json +13 -0
- package/tests/artifacts/getDrmConfigurationById.sdk.json +31 -0
- package/tests/artifacts/get_timeseries_data.api.json +18 -0
- package/tests/artifacts/get_timeseries_data.sdk.json +18 -0
- package/tests/artifacts/get_video_view_details.api.json +213 -0
- package/tests/artifacts/get_video_view_details.sdk.json +213 -0
- package/tests/artifacts/list-live-clips.api.json +9 -0
- package/tests/artifacts/list-live-clips.sdk.json +9 -0
- package/tests/artifacts/list-media.api.json +65 -0
- package/tests/artifacts/list-media.sdk.json +65 -0
- package/tests/artifacts/list-playback-ids.api.json +21 -0
- package/tests/artifacts/list-playback-ids.sdk.json +21 -0
- package/tests/artifacts/list-uploads.api.json +43 -0
- package/tests/artifacts/list-uploads.sdk.json +43 -0
- package/tests/artifacts/list_breakdown_values.api.json +24 -0
- package/tests/artifacts/list_breakdown_values.sdk.json +24 -0
- package/tests/artifacts/list_by_top_content.api.json +19 -0
- package/tests/artifacts/list_by_top_content.sdk.json +19 -0
- package/tests/artifacts/list_comparison_values.api.json +350 -0
- package/tests/artifacts/list_comparison_values.sdk.json +350 -0
- package/tests/artifacts/list_dimensions.api.json +61 -0
- package/tests/artifacts/list_dimensions.sdk.json +61 -0
- package/tests/artifacts/list_errors.api.json +51 -0
- package/tests/artifacts/list_errors.sdk.json +51 -0
- package/tests/artifacts/list_filter_values_for_dimension.api.json +14 -0
- package/tests/artifacts/list_filter_values_for_dimension.sdk.json +14 -0
- package/tests/artifacts/list_overall_values.api.json +18 -0
- package/tests/artifacts/list_overall_values.sdk.json +18 -0
- package/tests/artifacts/list_signing_keys.api.json +22 -0
- package/tests/artifacts/list_signing_keys.sdk.json +22 -0
- package/tests/artifacts/list_video_views.api.json +84 -0
- package/tests/artifacts/list_video_views.sdk.json +84 -0
- package/tests/artifacts/retrieveMediaInputInfo.api.json +28 -0
- package/tests/artifacts/retrieveMediaInputInfo.sdk.json +28 -0
- package/tests/artifacts-non-get/Add-media-track.raw.json +10 -0
- package/tests/artifacts-non-get/Add-media-track.sdk.json +10 -0
- package/tests/artifacts-non-get/Generate-subtitle-track.raw.json +9 -0
- package/tests/artifacts-non-get/Generate-subtitle-track.sdk.json +9 -0
- package/tests/artifacts-non-get/add-media-to-playlist.raw.json +24 -0
- package/tests/artifacts-non-get/add-media-to-playlist.sdk.json +24 -0
- package/tests/artifacts-non-get/cancel-upload.raw.json +15 -0
- package/tests/artifacts-non-get/cancel-upload.sdk.json +15 -0
- package/tests/artifacts-non-get/change-media-order-in-playlist.raw.json +24 -0
- package/tests/artifacts-non-get/change-media-order-in-playlist.sdk.json +24 -0
- package/tests/artifacts-non-get/complete-live-stream.raw.json +8 -0
- package/tests/artifacts-non-get/complete-live-stream.sdk.json +13 -0
- package/tests/artifacts-non-get/create-a-playlist.raw.json +15 -0
- package/tests/artifacts-non-get/create-a-playlist.sdk.json +15 -0
- package/tests/artifacts-non-get/create-media-playback-id.raw.json +20 -0
- package/tests/artifacts-non-get/create-media-playback-id.sdk.json +19 -0
- package/tests/artifacts-non-get/create-media.raw.json +41 -0
- package/tests/artifacts-non-get/create-media.sdk.json +41 -0
- package/tests/artifacts-non-get/create-new-stream.raw.json +32 -0
- package/tests/artifacts-non-get/create-new-stream.sdk.json +32 -0
- package/tests/artifacts-non-get/create-playbackId-of-stream.raw.json +7 -0
- package/tests/artifacts-non-get/create-playbackId-of-stream.sdk.json +7 -0
- package/tests/artifacts-non-get/create-simulcast-of-stream.raw.json +9 -0
- package/tests/artifacts-non-get/create-simulcast-of-stream.sdk.json +9 -0
- package/tests/artifacts-non-get/create_signing_key.raw.json +8 -0
- package/tests/artifacts-non-get/create_signing_key.sdk.json +8 -0
- package/tests/artifacts-non-get/delete-a-playlist.raw.json +3 -0
- package/tests/artifacts-non-get/delete-a-playlist.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-live-stream.raw.json +3 -0
- package/tests/artifacts-non-get/delete-live-stream.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-media-from-playlist.raw.json +15 -0
- package/tests/artifacts-non-get/delete-media-from-playlist.sdk.json +15 -0
- package/tests/artifacts-non-get/delete-media-playback-id.raw.json +3 -0
- package/tests/artifacts-non-get/delete-media-playback-id.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-media-track.raw.json +3 -0
- package/tests/artifacts-non-get/delete-media-track.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-media.raw.json +3 -0
- package/tests/artifacts-non-get/delete-media.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-playbackId-of-stream.raw.json +3 -0
- package/tests/artifacts-non-get/delete-playbackId-of-stream.sdk.json +3 -0
- package/tests/artifacts-non-get/delete-simulcast-of-stream.raw.json +3 -0
- package/tests/artifacts-non-get/delete-simulcast-of-stream.sdk.json +3 -0
- package/tests/artifacts-non-get/delete_signing_key.raw.json +6 -0
- package/tests/artifacts-non-get/delete_signing_key.sdk.json +6 -0
- package/tests/artifacts-non-get/direct-upload-video-media.raw.json +36 -0
- package/tests/artifacts-non-get/direct-upload-video-media.sdk.json +36 -0
- package/tests/artifacts-non-get/disable-live-stream.raw.json +3 -0
- package/tests/artifacts-non-get/disable-live-stream.sdk.json +3 -0
- package/tests/artifacts-non-get/enable-live-stream.raw.json +3 -0
- package/tests/artifacts-non-get/enable-live-stream.sdk.json +3 -0
- package/tests/artifacts-non-get/update-a-playlist.raw.json +15 -0
- package/tests/artifacts-non-get/update-a-playlist.sdk.json +15 -0
- package/tests/artifacts-non-get/update-domain-restrictions.raw.json +10 -0
- package/tests/artifacts-non-get/update-domain-restrictions.sdk.json +10 -0
- package/tests/artifacts-non-get/update-live-stream.raw.json +36 -0
- package/tests/artifacts-non-get/update-live-stream.sdk.json +36 -0
- package/tests/artifacts-non-get/update-media-chapters.raw.json +7 -0
- package/tests/artifacts-non-get/update-media-chapters.sdk.json +7 -0
- package/tests/artifacts-non-get/update-media-moderation.raw.json +7 -0
- package/tests/artifacts-non-get/update-media-moderation.sdk.json +7 -0
- package/tests/artifacts-non-get/update-media-named-entities.raw.json +7 -0
- package/tests/artifacts-non-get/update-media-named-entities.sdk.json +7 -0
- package/tests/artifacts-non-get/update-media-summary.raw.json +7 -0
- package/tests/artifacts-non-get/update-media-summary.sdk.json +7 -0
- package/tests/artifacts-non-get/update-media-track.raw.json +10 -0
- package/tests/artifacts-non-get/update-media-track.sdk.json +10 -0
- package/tests/artifacts-non-get/update-specific-simulcast-of-stream.raw.json +9 -0
- package/tests/artifacts-non-get/update-specific-simulcast-of-stream.sdk.json +9 -0
- package/tests/artifacts-non-get/update-user-agent-restrictions.raw.json +10 -0
- package/tests/artifacts-non-get/update-user-agent-restrictions.sdk.json +10 -0
- package/tests/artifacts-non-get/updated-media.raw.json +94 -0
- package/tests/artifacts-non-get/updated-media.sdk.json +94 -0
- package/tests/artifacts-non-get/updated-mp4Support.raw.json +95 -0
- package/tests/artifacts-non-get/updated-mp4Support.sdk.json +95 -0
- package/tests/artifacts-non-get/updated-source-access.raw.json +94 -0
- package/tests/artifacts-non-get/updated-source-access.sdk.json +94 -0
- package/tests/build-url-mapping-pass2.mjs +77 -0
- package/tests/build-url-mapping.mjs +101 -0
- package/tests/check-broken-links.mjs +89 -0
- package/tests/diff-api-vs-sdk.mjs +94 -0
- package/tests/diff-passed.mjs +99 -0
- package/tests/diff-strict.mjs +81 -0
- package/tests/non-get-endpoints-fixtures.json +328 -0
- package/tests/validate-get-endpoints.ts +16 -5
- package/tests/validate-non-get-endpoints.ts +477 -0
- package/tests/validate-non-get-lifecycle.ts +1093 -0
|
@@ -23,11 +23,11 @@ import { Result } from "../types/fp.js";
|
|
|
23
23
|
*
|
|
24
24
|
* #### Webhook Events
|
|
25
25
|
*
|
|
26
|
-
* 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://docs.fastpix.
|
|
26
|
+
* 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasubtitlegeneratedready">video.media.subtitle.generated.ready</a>.
|
|
27
27
|
*
|
|
28
|
-
* 2. Finally the <a href="https://docs.fastpix.
|
|
28
|
+
* 2. Finally the <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> event notifies your system about the media’s updated status.
|
|
29
29
|
*
|
|
30
|
-
* </br> Related guide: <a href="https://docs.fastpix.
|
|
30
|
+
* </br> Related guide: <a href="https://docs.fastpix.com/docs/add-auto-generated-subtitles-to-videos">Add auto-generated subtitles</a>
|
|
31
31
|
*/
|
|
32
32
|
export declare function manageVideosGenerateSubtitleTrack(client: FastpixCore, request: operations.GenerateSubtitleTrackRequest, options?: RequestOptions): APIPromise<Result<operations.GenerateSubtitleTrackResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
33
33
|
//# sourceMappingURL=manageVideosGenerateSubtitleTrack.d.ts.map
|
|
@@ -28,11 +28,11 @@ import { APIPromise } from "../types/async.js";
|
|
|
28
28
|
*
|
|
29
29
|
* #### Webhook Events
|
|
30
30
|
*
|
|
31
|
-
* 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://docs.fastpix.
|
|
31
|
+
* 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasubtitlegeneratedready">video.media.subtitle.generated.ready</a>.
|
|
32
32
|
*
|
|
33
|
-
* 2. Finally the <a href="https://docs.fastpix.
|
|
33
|
+
* 2. Finally the <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> event notifies your system about the media’s updated status.
|
|
34
34
|
*
|
|
35
|
-
* </br> Related guide: <a href="https://docs.fastpix.
|
|
35
|
+
* </br> Related guide: <a href="https://docs.fastpix.com/docs/add-auto-generated-subtitles-to-videos">Add auto-generated subtitles</a>
|
|
36
36
|
*/
|
|
37
37
|
export function manageVideosGenerateSubtitleTrack(client, request, options) {
|
|
38
38
|
return new APIPromise($do(client, request, options));
|
|
@@ -21,7 +21,7 @@ import { Result } from "../types/fp.js";
|
|
|
21
21
|
* - **status** – Indicates whether the media is still *Processing* or has transitioned to *Ready*.
|
|
22
22
|
* - **playbackId** – A unique identifier that allows you to stream the media once it is *Ready*.
|
|
23
23
|
* You can construct the stream URL as follows:
|
|
24
|
-
* `https://stream.fastpix.
|
|
24
|
+
* `https://stream.fastpix.com/<playbackId>.m3u8`
|
|
25
25
|
*
|
|
26
26
|
* #### Example
|
|
27
27
|
*
|
|
@@ -26,7 +26,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
26
26
|
* - **status** – Indicates whether the media is still *Processing* or has transitioned to *Ready*.
|
|
27
27
|
* - **playbackId** – A unique identifier that allows you to stream the media once it is *Ready*.
|
|
28
28
|
* You can construct the stream URL as follows:
|
|
29
|
-
* `https://stream.fastpix.
|
|
29
|
+
* `https://stream.fastpix.com/<playbackId>.m3u8`
|
|
30
30
|
*
|
|
31
31
|
* #### Example
|
|
32
32
|
*
|
|
@@ -21,7 +21,7 @@ import { Result } from "../types/fp.js";
|
|
|
21
21
|
*
|
|
22
22
|
* 3. The response returns the updated media data, confirming the changes.
|
|
23
23
|
*
|
|
24
|
-
* 4. Monitor the <a href="https://docs.fastpix.
|
|
24
|
+
* 4. Monitor the <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> webhook event to track the update status in your system.
|
|
25
25
|
*
|
|
26
26
|
* #### Example
|
|
27
27
|
* If a user uploads a video and later needs to change the title, add a new description, or update tags, you can use this endpoint to update the media metadata without re-uploading the entire video.
|
|
@@ -26,7 +26,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
26
26
|
*
|
|
27
27
|
* 3. The response returns the updated media data, confirming the changes.
|
|
28
28
|
*
|
|
29
|
-
* 4. Monitor the <a href="https://docs.fastpix.
|
|
29
|
+
* 4. Monitor the <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> webhook event to track the update status in your system.
|
|
30
30
|
*
|
|
31
31
|
* #### Example
|
|
32
32
|
* If a user uploads a video and later needs to change the title, add a new description, or update tags, you can use this endpoint to update the media metadata without re-uploading the entire video.
|
|
@@ -33,12 +33,12 @@ import { Result } from "../types/fp.js";
|
|
|
33
33
|
*
|
|
34
34
|
* #### Webhook events
|
|
35
35
|
*
|
|
36
|
-
* - <a href="https://docs.fastpix.
|
|
36
|
+
* - <a href="https://docs.fastpix.com/docs/transform-media-events#videomediamp4supportready">video.media.mp4Support.ready</a> – Triggered when the MP4 support setting is successfully updated.
|
|
37
37
|
*
|
|
38
38
|
* #### Example
|
|
39
|
-
* Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting "mp4Support": "capped_4k", the system generates an MP4 rendition of the video up to 4K resolution, making it available for download through the stream URL(`https://stream.fastpix.
|
|
39
|
+
* Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting "mp4Support": "capped_4k", the system generates an MP4 rendition of the video up to 4K resolution, making it available for download through the stream URL(`https://stream.fastpix.com/{playbackId}/{capped-4k.mp4 | audio.m4a}`). If you want users to stream only the audio from the media file, you can set "mp4Support": "audioOnly". This provides an audio-only stream URL that allows users to listen to the media without video. By setting "mp4Support": "audioOnly,capped_4k", both options are enabled. Users can download the MP4 video and also stream just the audio version of the media.
|
|
40
40
|
*
|
|
41
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
41
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>
|
|
42
42
|
*/
|
|
43
43
|
export declare function manageVideosUpdateMp4Support(client: FastpixCore, request: operations.UpdatedMp4SupportRequest, options?: RequestOptions): APIPromise<Result<operations.UpdatedMp4SupportResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
44
44
|
//# sourceMappingURL=manageVideosUpdateMp4Support.d.ts.map
|
|
@@ -38,12 +38,12 @@ import { APIPromise } from "../types/async.js";
|
|
|
38
38
|
*
|
|
39
39
|
* #### Webhook events
|
|
40
40
|
*
|
|
41
|
-
* - <a href="https://docs.fastpix.
|
|
41
|
+
* - <a href="https://docs.fastpix.com/docs/transform-media-events#videomediamp4supportready">video.media.mp4Support.ready</a> – Triggered when the MP4 support setting is successfully updated.
|
|
42
42
|
*
|
|
43
43
|
* #### Example
|
|
44
|
-
* Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting "mp4Support": "capped_4k", the system generates an MP4 rendition of the video up to 4K resolution, making it available for download through the stream URL(`https://stream.fastpix.
|
|
44
|
+
* Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting "mp4Support": "capped_4k", the system generates an MP4 rendition of the video up to 4K resolution, making it available for download through the stream URL(`https://stream.fastpix.com/{playbackId}/{capped-4k.mp4 | audio.m4a}`). If you want users to stream only the audio from the media file, you can set "mp4Support": "audioOnly". This provides an audio-only stream URL that allows users to listen to the media without video. By setting "mp4Support": "audioOnly,capped_4k", both options are enabled. Users can download the MP4 video and also stream just the audio version of the media.
|
|
45
45
|
*
|
|
46
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
46
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>
|
|
47
47
|
*/
|
|
48
48
|
export function manageVideosUpdateMp4Support(client, request, options) {
|
|
49
49
|
return new APIPromise($do(client, request, options));
|
|
@@ -25,11 +25,11 @@ import { Result } from "../types/fp.js";
|
|
|
25
25
|
*
|
|
26
26
|
* After updating a track, your system must receive webhook notifications:
|
|
27
27
|
*
|
|
28
|
-
* 1. After successfully updating a track, your system must receive the webhook event <a href="https://docs.fastpix.
|
|
28
|
+
* 1. After successfully updating a track, your system must receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediatrackupdated">video.media.track.updated</a>.
|
|
29
29
|
*
|
|
30
|
-
* 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.
|
|
30
|
+
* 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediatrackready">video.media.track.ready</a>.
|
|
31
31
|
*
|
|
32
|
-
* 3. Once the media file is updated with the new track details, a <a href="https://docs.fastpix.
|
|
32
|
+
* 3. Once the media file is updated with the new track details, a <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
|
|
33
33
|
*
|
|
34
34
|
* #### Example
|
|
35
35
|
* Suppose you previously added a French subtitle track to a video but now need to update it with a different file. By calling this API, you can replace the existing subtitle file (.vtt) with a new one while keeping the same track ID. This is useful when:
|
|
@@ -37,7 +37,7 @@ import { Result } from "../types/fp.js";
|
|
|
37
37
|
* - The original track file has errors and needs correction.
|
|
38
38
|
* - You want to improve subtitle translations or replace an audio track with a better-quality version.
|
|
39
39
|
*
|
|
40
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
40
|
+
* Related guides: <a href="https://docs.fastpix.com/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.com/docs/manage-audio-tracks">Add own audio tracks</a>
|
|
41
41
|
*/
|
|
42
42
|
export declare function manageVideosUpdateTrack(client: FastpixCore, request: operations.UpdateMediaTrackRequest, options?: RequestOptions): APIPromise<Result<operations.UpdateMediaTrackResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
43
43
|
//# sourceMappingURL=manageVideosUpdateTrack.d.ts.map
|
|
@@ -30,11 +30,11 @@ import { APIPromise } from "../types/async.js";
|
|
|
30
30
|
*
|
|
31
31
|
* After updating a track, your system must receive webhook notifications:
|
|
32
32
|
*
|
|
33
|
-
* 1. After successfully updating a track, your system must receive the webhook event <a href="https://docs.fastpix.
|
|
33
|
+
* 1. After successfully updating a track, your system must receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediatrackupdated">video.media.track.updated</a>.
|
|
34
34
|
*
|
|
35
|
-
* 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.
|
|
35
|
+
* 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediatrackready">video.media.track.ready</a>.
|
|
36
36
|
*
|
|
37
|
-
* 3. Once the media file is updated with the new track details, a <a href="https://docs.fastpix.
|
|
37
|
+
* 3. Once the media file is updated with the new track details, a <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
|
|
38
38
|
*
|
|
39
39
|
* #### Example
|
|
40
40
|
* Suppose you previously added a French subtitle track to a video but now need to update it with a different file. By calling this API, you can replace the existing subtitle file (.vtt) with a new one while keeping the same track ID. This is useful when:
|
|
@@ -42,7 +42,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
42
42
|
* - The original track file has errors and needs correction.
|
|
43
43
|
* - You want to improve subtitle translations or replace an audio track with a better-quality version.
|
|
44
44
|
*
|
|
45
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
45
|
+
* Related guides: <a href="https://docs.fastpix.com/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.com/docs/manage-audio-tracks">Add own audio tracks</a>
|
|
46
46
|
*/
|
|
47
47
|
export function manageVideosUpdateTrack(client, request, options) {
|
|
48
48
|
return new APIPromise($do(client, request, options));
|
|
@@ -23,7 +23,7 @@ import { Result } from "../types/fp.js";
|
|
|
23
23
|
*
|
|
24
24
|
* 1. After successfully deleting a track, your system must receive the webhook event **video.media.track.deleted**.
|
|
25
25
|
*
|
|
26
|
-
* 2. Once the media file is updated to reflect the track removal, a <a href="https://docs.fastpix.
|
|
26
|
+
* 2. Once the media file is updated to reflect the track removal, a <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
|
|
27
27
|
*
|
|
28
28
|
* #### Example
|
|
29
29
|
* Suppose you uploaded an audio track in Italian for a video but later realize it's incorrect or no longer needed. By calling this API, you can remove the specific track while keeping the rest of the media file unchanged. This is useful when:
|
|
@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
|
|
|
32
32
|
* - The content owner requests the removal of a specific subtitle or audio track.
|
|
33
33
|
* - A new version of the track gets uploaded to replace the existing one.
|
|
34
34
|
*
|
|
35
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
35
|
+
* Related guides: <a href="https://docs.fastpix.com/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.com/docs/manage-audio-tracks">Add own audio tracks</a>
|
|
36
36
|
*/
|
|
37
37
|
export declare function mediaDeleteTrack(client: FastpixCore, request: operations.DeleteMediaTrackRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteMediaTrackResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
38
38
|
//# sourceMappingURL=mediaDeleteTrack.d.ts.map
|
|
@@ -28,7 +28,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
28
28
|
*
|
|
29
29
|
* 1. After successfully deleting a track, your system must receive the webhook event **video.media.track.deleted**.
|
|
30
30
|
*
|
|
31
|
-
* 2. Once the media file is updated to reflect the track removal, a <a href="https://docs.fastpix.
|
|
31
|
+
* 2. Once the media file is updated to reflect the track removal, a <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> event must be triggered.
|
|
32
32
|
*
|
|
33
33
|
* #### Example
|
|
34
34
|
* Suppose you uploaded an audio track in Italian for a video but later realize it's incorrect or no longer needed. By calling this API, you can remove the specific track while keeping the rest of the media file unchanged. This is useful when:
|
|
@@ -37,7 +37,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
37
37
|
* - The content owner requests the removal of a specific subtitle or audio track.
|
|
38
38
|
* - A new version of the track gets uploaded to replace the existing one.
|
|
39
39
|
*
|
|
40
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
40
|
+
* Related guides: <a href="https://docs.fastpix.com/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.com/docs/manage-audio-tracks">Add own audio tracks</a>
|
|
41
41
|
*/
|
|
42
42
|
export function mediaDeleteTrack(client, request, options) {
|
|
43
43
|
return new APIPromise($do(client, request, options));
|
|
@@ -26,7 +26,7 @@ import { Result } from "../types/fp.js";
|
|
|
26
26
|
*
|
|
27
27
|
* Imagine you’re managing a video editing platform where users upload full-length videos and create short clips for social media sharing. To keep track of all clips linked to a particular video, you call this API with the sourceMediaId. The response provides a list of all associated clips, allowing you to manage, edit, or repurpose them as needed.
|
|
28
28
|
*
|
|
29
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
29
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/create-clips-from-existing-media">Create clips from existing media</a>
|
|
30
30
|
*/
|
|
31
31
|
export declare function mediaGetClips(client: FastpixCore, request: operations.GetMediaClipsRequest, options?: RequestOptions): APIPromise<Result<operations.GetMediaClipsResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
32
32
|
//# sourceMappingURL=mediaGetClips.d.ts.map
|
|
@@ -31,7 +31,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
31
31
|
*
|
|
32
32
|
* Imagine you’re managing a video editing platform where users upload full-length videos and create short clips for social media sharing. To keep track of all clips linked to a particular video, you call this API with the sourceMediaId. The response provides a list of all associated clips, allowing you to manage, edit, or repurpose them as needed.
|
|
33
33
|
*
|
|
34
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
34
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/create-clips-from-existing-media">Create clips from existing media</a>
|
|
35
35
|
*/
|
|
36
36
|
export function mediaGetClips(client, request, options) {
|
|
37
37
|
return new APIPromise($do(client, request, options));
|
|
@@ -20,7 +20,7 @@ import { Result } from "../types/fp.js";
|
|
|
20
20
|
* 2. Include the updated `sourceAccess` parameter in the request body.
|
|
21
21
|
*
|
|
22
22
|
* 3. You receive a response confirming the update to the media’s source access status.
|
|
23
|
-
* 4. Webhook events: <a href="https://docs.fastpix.
|
|
23
|
+
* 4. Webhook events: <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasourceready">video.media.source.ready</a>, <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasourcedeleted">video.media.source.deleted</a>
|
|
24
24
|
*/
|
|
25
25
|
export declare function mediaUpdateSourceAccess(client: FastpixCore, request: operations.UpdatedSourceAccessRequest, options?: RequestOptions): APIPromise<Result<operations.UpdatedSourceAccessResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
26
26
|
//# sourceMappingURL=mediaUpdateSourceAccess.d.ts.map
|
|
@@ -25,7 +25,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
25
25
|
* 2. Include the updated `sourceAccess` parameter in the request body.
|
|
26
26
|
*
|
|
27
27
|
* 3. You receive a response confirming the update to the media’s source access status.
|
|
28
|
-
* 4. Webhook events: <a href="https://docs.fastpix.
|
|
28
|
+
* 4. Webhook events: <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasourceready">video.media.source.ready</a>, <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasourcedeleted">video.media.source.deleted</a>
|
|
29
29
|
*/
|
|
30
30
|
export function mediaUpdateSourceAccess(client, request, options) {
|
|
31
31
|
return new APIPromise($do(client, request, options));
|
|
@@ -15,7 +15,7 @@ import { Result } from "../types/fp.js";
|
|
|
15
15
|
*
|
|
16
16
|
* #### How it works
|
|
17
17
|
*
|
|
18
|
-
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.
|
|
18
|
+
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.com/reference/list_dimensions">List Dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
|
|
19
19
|
*
|
|
20
20
|
* 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
|
|
21
21
|
*
|
|
@@ -37,7 +37,7 @@ import { Result } from "../types/fp.js";
|
|
|
37
37
|
* * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
|
|
38
38
|
* * **field:** The grouping field value based on the groupBy parameter.
|
|
39
39
|
*
|
|
40
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
40
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
|
|
41
41
|
*/
|
|
42
42
|
export declare function metricsListBreakdownValues(client: FastpixCore, request: operations.ListBreakdownValuesRequest, options?: RequestOptions): APIPromise<Result<operations.ListBreakdownValuesResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
43
43
|
//# sourceMappingURL=metricsListBreakdownValues.d.ts.map
|
|
@@ -20,7 +20,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
20
20
|
*
|
|
21
21
|
* #### How it works
|
|
22
22
|
*
|
|
23
|
-
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.
|
|
23
|
+
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.com/reference/list_dimensions">List Dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
|
|
24
24
|
*
|
|
25
25
|
* 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
|
|
26
26
|
*
|
|
@@ -42,7 +42,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
42
42
|
* * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
|
|
43
43
|
* * **field:** The grouping field value based on the groupBy parameter.
|
|
44
44
|
*
|
|
45
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
45
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
|
|
46
46
|
*/
|
|
47
47
|
export function metricsListBreakdownValues(client, request, options) {
|
|
48
48
|
return new APIPromise($do(client, request, options));
|
|
@@ -24,13 +24,13 @@ import { Result } from "../types/fp.js";
|
|
|
24
24
|
*
|
|
25
25
|
* #### How it works
|
|
26
26
|
*
|
|
27
|
-
* 1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.
|
|
27
|
+
* 1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.com/reference/list_dimensions">list dimensions</a> endpoint to obtain all available dimensions that can be used for comparison.
|
|
28
28
|
*
|
|
29
29
|
* 2. Send a `GET` request to this endpoint with the desired metrics specified in the query parameters.
|
|
30
30
|
*
|
|
31
31
|
* 3. You Receive a response containing the comparison values for the specified metrics across the selected dimensions.
|
|
32
32
|
*
|
|
33
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
33
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#compare-metrics">Compare metrics in dashboard</a>
|
|
34
34
|
*/
|
|
35
35
|
export declare function metricsListCompares(client: FastpixCore, request?: operations.ListComparisonValuesRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.ListComparisonValuesResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
36
36
|
//# sourceMappingURL=metricsListCompares.d.ts.map
|
|
@@ -29,13 +29,13 @@ import { APIPromise } from "../types/async.js";
|
|
|
29
29
|
*
|
|
30
30
|
* #### How it works
|
|
31
31
|
*
|
|
32
|
-
* 1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.
|
|
32
|
+
* 1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.com/reference/list_dimensions">list dimensions</a> endpoint to obtain all available dimensions that can be used for comparison.
|
|
33
33
|
*
|
|
34
34
|
* 2. Send a `GET` request to this endpoint with the desired metrics specified in the query parameters.
|
|
35
35
|
*
|
|
36
36
|
* 3. You Receive a response containing the comparison values for the specified metrics across the selected dimensions.
|
|
37
37
|
*
|
|
38
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
38
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#compare-metrics">Compare metrics in dashboard</a>
|
|
39
39
|
*/
|
|
40
40
|
export function metricsListCompares(client, request, options) {
|
|
41
41
|
return new APIPromise($do(client, request, options));
|
|
@@ -15,7 +15,7 @@ import { Result } from "../types/fp.js";
|
|
|
15
15
|
*
|
|
16
16
|
* #### How it works
|
|
17
17
|
*
|
|
18
|
-
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.
|
|
18
|
+
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.com/reference/list_dimensions">list dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
|
|
19
19
|
*
|
|
20
20
|
* 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
|
|
21
21
|
*
|
|
@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
|
|
|
30
30
|
* * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
|
|
31
31
|
* * **globalValue:** A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan. This value is not affected by specific filters.
|
|
32
32
|
*
|
|
33
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
33
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
|
|
34
34
|
*/
|
|
35
35
|
export declare function metricsListOverallValues(client: FastpixCore, request: operations.ListOverallValuesRequest, options?: RequestOptions): APIPromise<Result<operations.ListOverallValuesResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
36
36
|
//# sourceMappingURL=metricsListOverallValues.d.ts.map
|
|
@@ -20,7 +20,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
20
20
|
*
|
|
21
21
|
* #### How it works
|
|
22
22
|
*
|
|
23
|
-
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.
|
|
23
|
+
* 1. Before using this endpoint, you can call the <a href="https://docs.fastpix.com/reference/list_dimensions">list dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
|
|
24
24
|
*
|
|
25
25
|
* 2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
|
|
26
26
|
*
|
|
@@ -35,7 +35,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
35
35
|
* * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
|
|
36
36
|
* * **globalValue:** A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan. This value is not affected by specific filters.
|
|
37
37
|
*
|
|
38
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
38
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
|
|
39
39
|
*/
|
|
40
40
|
export function metricsListOverallValues(client, request, options) {
|
|
41
41
|
return new APIPromise($do(client, request, options));
|
|
@@ -11,7 +11,7 @@ import { Result } from "../types/fp.js";
|
|
|
11
11
|
* Create a playback ID
|
|
12
12
|
*
|
|
13
13
|
* @remarks
|
|
14
|
-
* You can create a new playback ID for a specific media asset. If you have already retrieved an existing `playbackId` using the <a href="https://docs.fastpix.
|
|
14
|
+
* You can create a new playback ID for a specific media asset. If you have already retrieved an existing `playbackId` using the <a href="https://docs.fastpix.com/reference/get-media">Get Media by ID</a> endpoint for a media asset, you can use this endpoint to generate a new playback ID with a specified access policy.
|
|
15
15
|
*
|
|
16
16
|
* If you want to create a private playback ID for a media asset that already has a public playback ID, this endpoint also allows you to do so by specifying the desired access policy.
|
|
17
17
|
*
|
|
@@ -16,7 +16,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
16
16
|
* Create a playback ID
|
|
17
17
|
*
|
|
18
18
|
* @remarks
|
|
19
|
-
* You can create a new playback ID for a specific media asset. If you have already retrieved an existing `playbackId` using the <a href="https://docs.fastpix.
|
|
19
|
+
* You can create a new playback ID for a specific media asset. If you have already retrieved an existing `playbackId` using the <a href="https://docs.fastpix.com/reference/get-media">Get Media by ID</a> endpoint for a media asset, you can use this endpoint to generate a new playback ID with a specified access policy.
|
|
20
20
|
*
|
|
21
21
|
* If you want to create a private playback ID for a media asset that already has a public playback ID, this endpoint also allows you to do so by specifying the desired access policy.
|
|
22
22
|
*
|
|
@@ -17,7 +17,7 @@ import { Result } from "../types/fp.js";
|
|
|
17
17
|
* - **Manual:** Creates an empty playlist without any initial media items. Use this mode for manual curation, where you add items later in a user-defined sequence.
|
|
18
18
|
* - **Smart:** Auto-populates the playlist at creation time based on the filter criteria (for example, a video creation date range) that you provide in the request.
|
|
19
19
|
*
|
|
20
|
-
* For more details, see <a href="https://docs.fastpix.
|
|
20
|
+
* For more details, see <a href="https://docs.fastpix.com/docs/create-and-manage-playlist">Create and manage playlist</a>.
|
|
21
21
|
*
|
|
22
22
|
* #### How it works
|
|
23
23
|
*
|
|
@@ -22,7 +22,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
22
22
|
* - **Manual:** Creates an empty playlist without any initial media items. Use this mode for manual curation, where you add items later in a user-defined sequence.
|
|
23
23
|
* - **Smart:** Auto-populates the playlist at creation time based on the filter criteria (for example, a video creation date range) that you provide in the request.
|
|
24
24
|
*
|
|
25
|
-
* For more details, see <a href="https://docs.fastpix.
|
|
25
|
+
* For more details, see <a href="https://docs.fastpix.com/docs/create-and-manage-playlist">Create and manage playlist</a>.
|
|
26
26
|
*
|
|
27
27
|
* #### How it works
|
|
28
28
|
*
|
|
@@ -26,7 +26,7 @@ import { Result } from "../types/fp.js";
|
|
|
26
26
|
* **Use case:** A developer building a video subscription service wants to ensure that only authorized users can access premium content. By generating a signing key, the developer can issue signed JSON Web Tokens (JWTs) to authenticate and authorize users. These tokens can be validated by FastPix using the stored public key.
|
|
27
27
|
*
|
|
28
28
|
* **Detailed example:** You are building a video-on-demand platform that restricts access based on user subscriptions. To ensure only subscribed users can stream content, you generate a signing key using this API. Each time a user logs in, you create a JWT signed with the private key. When the user attempts to play a video, FastPix uses the public key to verify the token and confirms that the user is authorized.<br/>
|
|
29
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
29
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-jwts">Create and use signing keys</a>
|
|
30
30
|
*/
|
|
31
31
|
export declare function signingKeysCreate(client: FastpixCore, options?: RequestOptions): APIPromise<Result<operations.CreateSigningKeyResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
32
32
|
//# sourceMappingURL=signingKeysCreate.d.ts.map
|
|
@@ -28,7 +28,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
28
28
|
* **Use case:** A developer building a video subscription service wants to ensure that only authorized users can access premium content. By generating a signing key, the developer can issue signed JSON Web Tokens (JWTs) to authenticate and authorize users. These tokens can be validated by FastPix using the stored public key.
|
|
29
29
|
*
|
|
30
30
|
* **Detailed example:** You are building a video-on-demand platform that restricts access based on user subscriptions. To ensure only subscribed users can stream content, you generate a signing key using this API. Each time a user logs in, you create a JWT signed with the private key. When the user attempts to play a video, FastPix uses the public key to verify the token and confirms that the user is authorized.<br/>
|
|
31
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
31
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-jwts">Create and use signing keys</a>
|
|
32
32
|
*/
|
|
33
33
|
export function signingKeysCreate(client, options) {
|
|
34
34
|
return new APIPromise($do(client, options));
|
|
@@ -23,7 +23,7 @@ import { Result } from "../types/fp.js";
|
|
|
23
23
|
* {
|
|
24
24
|
* "kid": "359302ee-2446-4afe-9348-8b4656b9ddb1",
|
|
25
25
|
* "aud": "media:6cee6f85-9334-4a51-9ce3-e0241d94ceef",
|
|
26
|
-
* "iss": "fastpix.
|
|
26
|
+
* "iss": "fastpix.com",
|
|
27
27
|
* "sub": "",
|
|
28
28
|
* "iat": 1706703204,
|
|
29
29
|
* "exp": 1735626783
|
|
@@ -33,7 +33,7 @@ import { Result } from "../types/fp.js";
|
|
|
33
33
|
*
|
|
34
34
|
* * **kid:** The key ID of the signing key.
|
|
35
35
|
* * **aud:** The audience for which the token is intended, enter the playbackId here.
|
|
36
|
-
* * **iss:** The issuer of the token (for example, "fastpix.
|
|
36
|
+
* * **iss:** The issuer of the token (for example, "fastpix.com ").
|
|
37
37
|
* * **sub:** The subject of the token, typically representing the user or entity the token is issued for. In this case, use the workspaceId fetched from the "Get Signing Key by ID" endpoint.
|
|
38
38
|
* * **groups:** An array of groups the subject belongs to (for example, ["user"]).
|
|
39
39
|
* * **iat:** The issued-at timestamp, indicating when the token was created.
|
|
@@ -28,7 +28,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
28
28
|
* {
|
|
29
29
|
* "kid": "359302ee-2446-4afe-9348-8b4656b9ddb1",
|
|
30
30
|
* "aud": "media:6cee6f85-9334-4a51-9ce3-e0241d94ceef",
|
|
31
|
-
* "iss": "fastpix.
|
|
31
|
+
* "iss": "fastpix.com",
|
|
32
32
|
* "sub": "",
|
|
33
33
|
* "iat": 1706703204,
|
|
34
34
|
* "exp": 1735626783
|
|
@@ -38,7 +38,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
38
38
|
*
|
|
39
39
|
* * **kid:** The key ID of the signing key.
|
|
40
40
|
* * **aud:** The audience for which the token is intended, enter the playbackId here.
|
|
41
|
-
* * **iss:** The issuer of the token (for example, "fastpix.
|
|
41
|
+
* * **iss:** The issuer of the token (for example, "fastpix.com ").
|
|
42
42
|
* * **sub:** The subject of the token, typically representing the user or entity the token is issued for. In this case, use the workspaceId fetched from the "Get Signing Key by ID" endpoint.
|
|
43
43
|
* * **groups:** An array of groups the subject belongs to (for example, ["user"]).
|
|
44
44
|
* * **iat:** The issued-at timestamp, indicating when the token was created.
|
|
@@ -13,7 +13,7 @@ import { Result } from "../types/fp.js";
|
|
|
13
13
|
* @remarks
|
|
14
14
|
* Deletes a simulcast using its unique simulcastId, which you received during the simulcast creation process. Deleting a simulcast stops the broadcast to the associated platform, while the parent stream continues if it’s live. This action can’t be undone, and you must create a new simulcast to resume streaming to the same platform.
|
|
15
15
|
*
|
|
16
|
-
* Webhook event: <a href="https://docs.fastpix.
|
|
16
|
+
* Webhook event: <a href="https://docs.fastpix.com/docs/live-events#videolive_streamsimulcast_targetdeleted">video.live_stream.simulcast_target.deleted</a>
|
|
17
17
|
*
|
|
18
18
|
* #### Example
|
|
19
19
|
* A broadcaster may need to stop simulcasting to one platform while keeping the stream active on others. For example, a tech company is simulcasting a product launch across multiple platforms. Midway through the event, they decide to stop the simulcast on Facebook due to performance issues but continue streaming on YouTube. They use this API to delete the Facebook simulcast target.
|
|
@@ -18,7 +18,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
18
18
|
* @remarks
|
|
19
19
|
* Deletes a simulcast using its unique simulcastId, which you received during the simulcast creation process. Deleting a simulcast stops the broadcast to the associated platform, while the parent stream continues if it’s live. This action can’t be undone, and you must create a new simulcast to resume streaming to the same platform.
|
|
20
20
|
*
|
|
21
|
-
* Webhook event: <a href="https://docs.fastpix.
|
|
21
|
+
* Webhook event: <a href="https://docs.fastpix.com/docs/live-events#videolive_streamsimulcast_targetdeleted">video.live_stream.simulcast_target.deleted</a>
|
|
22
22
|
*
|
|
23
23
|
* #### Example
|
|
24
24
|
* A broadcaster may need to stop simulcasting to one platform while keeping the stream active on others. For example, a tech company is simulcasting a product launch across multiple platforms. Midway through the event, they decide to stop the simulcast on Facebook due to performance issues but continue streaming on YouTube. They use this API to delete the Facebook simulcast target.
|
|
@@ -16,12 +16,12 @@ import { Result } from "../types/fp.js";
|
|
|
16
16
|
*
|
|
17
17
|
* 1. Change to: When you call this endpoint, provide the parent `streamId` along with the simulcast target details (such as platform and credentials). The API returns a unique `simulcastId`, which you can use to manage the simulcast later.
|
|
18
18
|
*
|
|
19
|
-
* 2. To notify your application about the status of simulcast related events check for the <a href="https://docs.fastpix.
|
|
19
|
+
* 2. To notify your application about the status of simulcast related events check for the <a href="https://docs.fastpix.com/docs/webhooks-collection#simulcast-target-events">webhooks for simulcast</a> target events.
|
|
20
20
|
*
|
|
21
21
|
* #### Example
|
|
22
22
|
* An event manager sets up a live stream for a virtual conference and wants to simulcast the stream on YouTube and Facebook Live. They first create the primary live stream in FastPix, ensuring it's in the idle state. Then, they use the API to create a simulcast target for YouTube.
|
|
23
23
|
*
|
|
24
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
24
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/simulcast-to-3rd-party-platforms">Simulcast to 3rd party platforms</a>
|
|
25
25
|
*/
|
|
26
26
|
export declare function simulcastsCreate(client: FastpixCore, request: operations.CreateSimulcastOfStreamRequest, options?: RequestOptions): APIPromise<Result<operations.CreateSimulcastOfStreamResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
27
27
|
//# sourceMappingURL=simulcastsCreate.d.ts.map
|
|
@@ -21,12 +21,12 @@ import { APIPromise } from "../types/async.js";
|
|
|
21
21
|
*
|
|
22
22
|
* 1. Change to: When you call this endpoint, provide the parent `streamId` along with the simulcast target details (such as platform and credentials). The API returns a unique `simulcastId`, which you can use to manage the simulcast later.
|
|
23
23
|
*
|
|
24
|
-
* 2. To notify your application about the status of simulcast related events check for the <a href="https://docs.fastpix.
|
|
24
|
+
* 2. To notify your application about the status of simulcast related events check for the <a href="https://docs.fastpix.com/docs/webhooks-collection#simulcast-target-events">webhooks for simulcast</a> target events.
|
|
25
25
|
*
|
|
26
26
|
* #### Example
|
|
27
27
|
* An event manager sets up a live stream for a virtual conference and wants to simulcast the stream on YouTube and Facebook Live. They first create the primary live stream in FastPix, ensuring it's in the idle state. Then, they use the API to create a simulcast target for YouTube.
|
|
28
28
|
*
|
|
29
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
29
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/simulcast-to-3rd-party-platforms">Simulcast to 3rd party platforms</a>
|
|
30
30
|
*/
|
|
31
31
|
export function simulcastsCreate(client, request, options) {
|
|
32
32
|
return new APIPromise($do(client, request, options));
|
|
@@ -13,7 +13,7 @@ import { Result } from "../types/fp.js";
|
|
|
13
13
|
* @remarks
|
|
14
14
|
* Updates the status of a specific simulcast linked to a parent live stream. You can enable or disable the simulcast at any time while the parent stream is active or idle. After the live stream is disabled, the simulcast can no longer be modified.
|
|
15
15
|
*
|
|
16
|
-
* Webhook event: <a href="https://docs.fastpix.
|
|
16
|
+
* Webhook event: <a href="https://docs.fastpix.com/docs/live-events#videolive_streamsimulcast_targetupdated">video.live_stream.simulcast_target.updated</a>
|
|
17
17
|
*
|
|
18
18
|
* #### Example
|
|
19
19
|
* When a `PATCH` request is made to this endpoint, the API updates the status of the simulcast. This can be useful for pausing or resuming a simulcast on a particular platform without stopping the parent live stream.
|
|
@@ -18,7 +18,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
18
18
|
* @remarks
|
|
19
19
|
* Updates the status of a specific simulcast linked to a parent live stream. You can enable or disable the simulcast at any time while the parent stream is active or idle. After the live stream is disabled, the simulcast can no longer be modified.
|
|
20
20
|
*
|
|
21
|
-
* Webhook event: <a href="https://docs.fastpix.
|
|
21
|
+
* Webhook event: <a href="https://docs.fastpix.com/docs/live-events#videolive_streamsimulcast_targetupdated">video.live_stream.simulcast_target.updated</a>
|
|
22
22
|
*
|
|
23
23
|
* #### Example
|
|
24
24
|
* When a `PATCH` request is made to this endpoint, the API updates the status of the simulcast. This can be useful for pausing or resuming a simulcast on a particular platform without stopping the parent live stream.
|
|
@@ -19,7 +19,7 @@ import { Result } from "../types/fp.js";
|
|
|
19
19
|
*
|
|
20
20
|
* If a developer receives a report of a poor viewing experience for a specific user. By using this endpoint with the users `viewId`, the developer can retrieve metrics like buffering duration, playback errors, and session length. This data allows the developer to pinpoint issues (such as poor connectivity or a browser-specific problem) and take steps to improve the user experience.
|
|
21
21
|
*
|
|
22
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
22
|
+
* Related guide: <a href="https://docs.fastpix.com/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a>
|
|
23
23
|
*/
|
|
24
24
|
export declare function viewsGetDetails(client: FastpixCore, request: operations.GetVideoViewDetailsRequest, options?: RequestOptions): APIPromise<Result<operations.GetVideoViewDetailsResponse, FastpixError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
25
25
|
//# sourceMappingURL=viewsGetDetails.d.ts.map
|
|
@@ -24,7 +24,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
24
24
|
*
|
|
25
25
|
* If a developer receives a report of a poor viewing experience for a specific user. By using this endpoint with the users `viewId`, the developer can retrieve metrics like buffering duration, playback errors, and session length. This data allows the developer to pinpoint issues (such as poor connectivity or a browser-specific problem) and take steps to improve the user experience.
|
|
26
26
|
*
|
|
27
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
27
|
+
* Related guide: <a href="https://docs.fastpix.com/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a>
|
|
28
28
|
*/
|
|
29
29
|
export function viewsGetDetails(client, request, options) {
|
|
30
30
|
return new APIPromise($do(client, request, options));
|