@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
|
@@ -43,13 +43,13 @@ class InputVideo extends sdks_js_1.ClientSDK {
|
|
|
43
43
|
*
|
|
44
44
|
* 3. Receive a response containing the unique id for the newly created media item.
|
|
45
45
|
*
|
|
46
|
-
* 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://docs.fastpix.
|
|
46
|
+
* 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://docs.fastpix.com/reference/get-media">Get Media by ID</a> endpoint to determine when the media is ready for playback.
|
|
47
47
|
*
|
|
48
|
-
* FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, after the media file is created (but not yet processed or encoded), FastPix sends a `POST` request to your specified webhook URL with the event <a href="https://docs.fastpix.
|
|
48
|
+
* FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, after the media file is created (but not yet processed or encoded), FastPix sends a `POST` request to your specified webhook URL with the event <a href="https://docs.fastpix.com/docs/media-events#videomediacreated">video.media.created</a>.
|
|
49
49
|
*
|
|
50
|
-
* After processing completes, monitor the events <a href="https://docs.fastpix.
|
|
50
|
+
* After processing completes, monitor the events <a href="https://docs.fastpix.com/docs/media-events#videomediaready">video.media.ready</a> and <a href="https://docs.fastpix.com/docs/media-events#videomediafailed">video.media.failed</a> to track the status of the media file.
|
|
51
51
|
*
|
|
52
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
52
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/upload-videos-from-url">Upload videos from URL</a>
|
|
53
53
|
*/
|
|
54
54
|
async create(request, options) {
|
|
55
55
|
return (0, fp_js_1.unwrapAsync)((0, inputVideoCreate_js_1.inputVideoCreate)(this, request, options));
|
|
@@ -62,7 +62,7 @@ class InputVideo extends sdks_js_1.ClientSDK {
|
|
|
62
62
|
*
|
|
63
63
|
* > **NOTE**
|
|
64
64
|
* >
|
|
65
|
-
* > This version now supports uploads with no file size limitations and offers faster uploads. The previous endpoint (which had a 500MB size limit) is now deprecated. You can find details in the [changelog](https://docs.fastpix.
|
|
65
|
+
* > This version now supports uploads with no file size limitations and offers faster uploads. The previous endpoint (which had a 500MB size limit) is now deprecated. You can find details in the [changelog](https://docs.fastpix.com/changelog/api-update-direct-upload-media-from-device).
|
|
66
66
|
*
|
|
67
67
|
* #### How it works
|
|
68
68
|
*
|
|
@@ -70,19 +70,19 @@ class InputVideo extends sdks_js_1.ClientSDK {
|
|
|
70
70
|
*
|
|
71
71
|
* 2. The response includes an `uploadId` and a signed `url` for direct video file upload.
|
|
72
72
|
*
|
|
73
|
-
* 3. Upload your video file to the provided url by making a PUT request. The API accepts the media file from your device and uploads it to the FastPix platform. (Refer to <a href="https://docs.fastpix.
|
|
73
|
+
* 3. Upload your video file to the provided url by making a PUT request. The API accepts the media file from your device and uploads it to the FastPix platform. (Refer to <a href="https://docs.fastpix.com/docs/upload-videos-directly#step-3-initiate-the-upload">Step 3: Initiate the upload</a> for complete instructions.)
|
|
74
74
|
*
|
|
75
75
|
* 4. Once uploaded, the media undergoes processing and is assigned a unique ID for tracking. Retain this `uploadId` for any future operations related to this upload.
|
|
76
76
|
*
|
|
77
|
-
* After uploading, you can use the <a href="https://docs.fastpix.
|
|
77
|
+
* After uploading, you can use the <a href="https://docs.fastpix.com/reference/get-media">Get Media by ID</a> endpoint to check the status of the uploaded media asset and see if it has transitioned to a `Ready` status for playback.
|
|
78
78
|
*
|
|
79
|
-
* To notify your application about the status of this API request check for the webhooks for <a href="https://docs.fastpix.
|
|
79
|
+
* To notify your application about the status of this API request check for the webhooks for <a href="https://docs.fastpix.com/docs/webhooks-collection#media-related-events">media related events</a>.
|
|
80
80
|
*
|
|
81
81
|
* #### Example
|
|
82
82
|
*
|
|
83
83
|
* A social media platform allows users to upload video content directly from their phones or computers. This endpoint facilitates the upload process. For example, if you are developing a video-sharing app where users can upload short clips from their mobile devices, this endpoint enables them to select a video, upload it to the platform.
|
|
84
84
|
*
|
|
85
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
85
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/upload-videos-directly">Upload videos directly</a>
|
|
86
86
|
*/
|
|
87
87
|
async upload(request, options) {
|
|
88
88
|
return (0, fp_js_1.unwrapAsync)((0, inputVideoUpload_js_1.inputVideoUpload)(this, request, options));
|
|
@@ -12,11 +12,11 @@ export declare class InVideoAI extends ClientSDK {
|
|
|
12
12
|
* 2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (for example, video/audio/av).
|
|
13
13
|
* 4. The response contains the updated media data, confirming the changes made.
|
|
14
14
|
*
|
|
15
|
-
* You can use the <a href="https://docs.fastpix.
|
|
15
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results.
|
|
16
16
|
*
|
|
17
17
|
* **Use case:** This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.
|
|
18
18
|
*
|
|
19
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
19
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/using-nsfw-and-profanity-filter-for-video-moderation">Moderate NSFW & Profanity</a>
|
|
20
20
|
*/
|
|
21
21
|
updateModeration(request: operations.UpdateMediaModerationRequest, options?: RequestOptions): Promise<operations.UpdateMediaModerationResponse>;
|
|
22
22
|
}
|
|
@@ -21,11 +21,11 @@ class InVideoAI extends sdks_js_1.ClientSDK {
|
|
|
21
21
|
* 2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (for example, video/audio/av).
|
|
22
22
|
* 4. The response contains the updated media data, confirming the changes made.
|
|
23
23
|
*
|
|
24
|
-
* You can use the <a href="https://docs.fastpix.
|
|
24
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results.
|
|
25
25
|
*
|
|
26
26
|
* **Use case:** This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.
|
|
27
27
|
*
|
|
28
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
28
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/using-nsfw-and-profanity-filter-for-video-moderation">Moderate NSFW & Profanity</a>
|
|
29
29
|
*/
|
|
30
30
|
async updateModeration(request, options) {
|
|
31
31
|
return (0, fp_js_1.unwrapAsync)((0, inVideoAIUpdateModeration_js_1.inVideoAIUpdateModeration)(this, request, options));
|
|
@@ -12,11 +12,11 @@ export declare class InVideoAIfeatures extends ClientSDK {
|
|
|
12
12
|
* 2. Include the `chapters` parameter in the request body to enable.
|
|
13
13
|
* 3. The response contains the updated media data, confirming the changes made.
|
|
14
14
|
*
|
|
15
|
-
* You can use the <a href="https://docs.fastpix.
|
|
15
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation.
|
|
16
16
|
*
|
|
17
17
|
* **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.
|
|
18
18
|
*
|
|
19
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
19
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-video-chapters">Video chapters</a>
|
|
20
20
|
*/
|
|
21
21
|
generateChapters(request: operations.UpdateMediaChaptersRequest, options?: RequestOptions): Promise<operations.UpdateMediaChaptersResponse>;
|
|
22
22
|
}
|
|
@@ -21,11 +21,11 @@ class InVideoAIfeatures extends sdks_js_1.ClientSDK {
|
|
|
21
21
|
* 2. Include the `chapters` parameter in the request body to enable.
|
|
22
22
|
* 3. The response contains the updated media data, confirming the changes made.
|
|
23
23
|
*
|
|
24
|
-
* You can use the <a href="https://docs.fastpix.
|
|
24
|
+
* You can use the <a href="https://docs.fastpix.com/docs/ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation.
|
|
25
25
|
*
|
|
26
26
|
* **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.
|
|
27
27
|
*
|
|
28
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
28
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/generate-video-chapters">Video chapters</a>
|
|
29
29
|
*/
|
|
30
30
|
async generateChapters(request, options) {
|
|
31
31
|
return (0, fp_js_1.unwrapAsync)((0, inVideoAIfeaturesGenerateChapters_js_1.inVideoAIfeaturesGenerateChapters)(this, request, options));
|
|
@@ -17,14 +17,14 @@ export declare class LiveStreams extends ClientSDK {
|
|
|
17
17
|
* #### Use case
|
|
18
18
|
* Suppose you’re hosting a live gaming event and want to showcase key moments from the stream — such as top plays or final match highlights. You can use this endpoint to fetch all clips generated from that livestream, display them in your dashboard, or use them for post-event editing and sharing.
|
|
19
19
|
*
|
|
20
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
20
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/instant-live-clipping">Instant live clipping</a>
|
|
21
21
|
*/
|
|
22
22
|
listClips(request: operations.ListLiveClipsRequest, options?: RequestOptions): Promise<operations.ListLiveClipsResponse>;
|
|
23
23
|
/**
|
|
24
24
|
* Create a new stream
|
|
25
25
|
*
|
|
26
26
|
* @remarks
|
|
27
|
-
* Creates a new <a href="https://docs.fastpix.
|
|
27
|
+
* Creates a new <a href="https://docs.fastpix.com/docs/get-started-with-live-streaming">RTMPS</a> or <a href="https://docs.fastpix.com/docs/using-srt-to-live-stream">SRT</a> live stream in FastPix. When you create a stream, FastPix generates a unique `streamKey` and `srtSecret` that you can use with broadcasting software such as OBS to connect to FastPix RTMPS or SRT servers. Use SRT for live streaming in unstable network conditions, as it provides error correction and encryption for a more reliable and secure broadcast.
|
|
28
28
|
*
|
|
29
29
|
* Leverage SRT for live streaming in environments with unstable networks, taking advantage of its error correction and encryption features for a resilient and secure broadcast.
|
|
30
30
|
*
|
|
@@ -34,13 +34,13 @@ export declare class LiveStreams extends ClientSDK {
|
|
|
34
34
|
*
|
|
35
35
|
* 2. FastPix returns the stream details for both RTMPS and SRT configurations. These keys and IDs from the stream details are essential for connecting the broadcasting software to FastPix’s servers and transmitting the live stream to viewers.
|
|
36
36
|
*
|
|
37
|
-
* 3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://docs.fastpix.
|
|
37
|
+
* 3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://docs.fastpix.com/docs/live-events#videolive_streamcreated">video.live_stream.created</a>.
|
|
38
38
|
*
|
|
39
39
|
* **Example:**
|
|
40
40
|
*
|
|
41
41
|
* Imagine a gaming platform that allows users to live stream gameplay directly from their dashboard. The API creates a new stream, provides the necessary stream key, and sets it to "private" so that only specific viewers can access it.
|
|
42
42
|
*
|
|
43
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
43
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/how-to-livestream">How to live stream</a>
|
|
44
44
|
*/
|
|
45
45
|
create(request: models.CreateLiveStreamRequest, options?: RequestOptions): Promise<operations.CreateNewStreamResponse>;
|
|
46
46
|
/**
|
|
@@ -60,13 +60,13 @@ export declare class LiveStreams extends ClientSDK {
|
|
|
60
60
|
* @remarks
|
|
61
61
|
* Permanently deletes a specified live stream from the workspace. If the stream is active, the encoder is disconnected and ingestion stops immediately. This action is irreversible, and any future playback attempts fail as a result.
|
|
62
62
|
*
|
|
63
|
-
* Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. You can further look for <a href="https://docs.fastpix.
|
|
63
|
+
* Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. You can further look for <a href="https://docs.fastpix.com/docs/live-events#videolive_streamdeleted">video.live_stream.deleted</a> webhook to notify your system about the status.
|
|
64
64
|
*
|
|
65
65
|
* #### Example
|
|
66
66
|
*
|
|
67
67
|
* For an online concert platform, a trial stream was mistakenly made public. The event manager deletes the stream before the concert begins to avoid confusion among viewers.
|
|
68
68
|
*
|
|
69
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
69
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
70
70
|
*/
|
|
71
71
|
delete(request: operations.DeleteLiveStreamRequest, options?: RequestOptions): Promise<operations.DeleteLiveStreamResponse>;
|
|
72
72
|
/**
|
|
@@ -83,7 +83,7 @@ export declare class LiveStreams extends ClientSDK {
|
|
|
83
83
|
*
|
|
84
84
|
* A creator disables a livestream to pause it temporarily. Later, they decide to continue the session. By calling this endpoint with the stream's ID, they can re-enable and restart the same livestream.
|
|
85
85
|
*
|
|
86
|
-
* Related guide <a href="https://docs.fastpix.
|
|
86
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
87
87
|
*/
|
|
88
88
|
enable(request: operations.EnableLiveStreamRequest, options?: RequestOptions): Promise<operations.EnableLiveStreamResponse>;
|
|
89
89
|
}
|
|
@@ -29,7 +29,7 @@ class LiveStreams extends sdks_js_1.ClientSDK {
|
|
|
29
29
|
* #### Use case
|
|
30
30
|
* Suppose you’re hosting a live gaming event and want to showcase key moments from the stream — such as top plays or final match highlights. You can use this endpoint to fetch all clips generated from that livestream, display them in your dashboard, or use them for post-event editing and sharing.
|
|
31
31
|
*
|
|
32
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
32
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/instant-live-clipping">Instant live clipping</a>
|
|
33
33
|
*/
|
|
34
34
|
async listClips(request, options) {
|
|
35
35
|
return (0, fp_js_1.unwrapAsync)((0, liveStreamsListClips_js_1.liveStreamsListClips)(this, request, options));
|
|
@@ -38,7 +38,7 @@ class LiveStreams extends sdks_js_1.ClientSDK {
|
|
|
38
38
|
* Create a new stream
|
|
39
39
|
*
|
|
40
40
|
* @remarks
|
|
41
|
-
* Creates a new <a href="https://docs.fastpix.
|
|
41
|
+
* Creates a new <a href="https://docs.fastpix.com/docs/get-started-with-live-streaming">RTMPS</a> or <a href="https://docs.fastpix.com/docs/using-srt-to-live-stream">SRT</a> live stream in FastPix. When you create a stream, FastPix generates a unique `streamKey` and `srtSecret` that you can use with broadcasting software such as OBS to connect to FastPix RTMPS or SRT servers. Use SRT for live streaming in unstable network conditions, as it provides error correction and encryption for a more reliable and secure broadcast.
|
|
42
42
|
*
|
|
43
43
|
* Leverage SRT for live streaming in environments with unstable networks, taking advantage of its error correction and encryption features for a resilient and secure broadcast.
|
|
44
44
|
*
|
|
@@ -48,13 +48,13 @@ class LiveStreams extends sdks_js_1.ClientSDK {
|
|
|
48
48
|
*
|
|
49
49
|
* 2. FastPix returns the stream details for both RTMPS and SRT configurations. These keys and IDs from the stream details are essential for connecting the broadcasting software to FastPix’s servers and transmitting the live stream to viewers.
|
|
50
50
|
*
|
|
51
|
-
* 3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://docs.fastpix.
|
|
51
|
+
* 3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://docs.fastpix.com/docs/live-events#videolive_streamcreated">video.live_stream.created</a>.
|
|
52
52
|
*
|
|
53
53
|
* **Example:**
|
|
54
54
|
*
|
|
55
55
|
* Imagine a gaming platform that allows users to live stream gameplay directly from their dashboard. The API creates a new stream, provides the necessary stream key, and sets it to "private" so that only specific viewers can access it.
|
|
56
56
|
*
|
|
57
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
57
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/how-to-livestream">How to live stream</a>
|
|
58
58
|
*/
|
|
59
59
|
async create(request, options) {
|
|
60
60
|
return (0, fp_js_1.unwrapAsync)((0, liveStreamsCreate_js_1.liveStreamsCreate)(this, request, options));
|
|
@@ -78,13 +78,13 @@ class LiveStreams extends sdks_js_1.ClientSDK {
|
|
|
78
78
|
* @remarks
|
|
79
79
|
* Permanently deletes a specified live stream from the workspace. If the stream is active, the encoder is disconnected and ingestion stops immediately. This action is irreversible, and any future playback attempts fail as a result.
|
|
80
80
|
*
|
|
81
|
-
* Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. You can further look for <a href="https://docs.fastpix.
|
|
81
|
+
* Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. You can further look for <a href="https://docs.fastpix.com/docs/live-events#videolive_streamdeleted">video.live_stream.deleted</a> webhook to notify your system about the status.
|
|
82
82
|
*
|
|
83
83
|
* #### Example
|
|
84
84
|
*
|
|
85
85
|
* For an online concert platform, a trial stream was mistakenly made public. The event manager deletes the stream before the concert begins to avoid confusion among viewers.
|
|
86
86
|
*
|
|
87
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
87
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
88
88
|
*/
|
|
89
89
|
async delete(request, options) {
|
|
90
90
|
return (0, fp_js_1.unwrapAsync)((0, liveStreamsDelete_js_1.liveStreamsDelete)(this, request, options));
|
|
@@ -103,7 +103,7 @@ class LiveStreams extends sdks_js_1.ClientSDK {
|
|
|
103
103
|
*
|
|
104
104
|
* A creator disables a livestream to pause it temporarily. Later, they decide to continue the session. By calling this endpoint with the stream's ID, they can re-enable and restart the same livestream.
|
|
105
105
|
*
|
|
106
|
-
* Related guide <a href="https://docs.fastpix.
|
|
106
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
107
107
|
*/
|
|
108
108
|
async enable(request, options) {
|
|
109
109
|
return (0, fp_js_1.unwrapAsync)((0, liveStreamsEnable_js_1.liveStreamsEnable)(this, request, options));
|
|
@@ -13,7 +13,7 @@ export declare class ManageLiveStream extends ClientSDK {
|
|
|
13
13
|
*
|
|
14
14
|
* Suppose a content creator is hosting a live concert and wants to display the number of live viewers on their dashboard. This endpoint can be queried to show up-to-date viewer statistics.
|
|
15
15
|
*
|
|
16
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
16
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
17
17
|
*/
|
|
18
18
|
getViewerCount(request: operations.GetLiveStreamViewerCountByIdRequest, options?: RequestOptions): Promise<operations.GetLiveStreamViewerCountByIdResponse>;
|
|
19
19
|
/**
|
|
@@ -25,7 +25,7 @@ export declare class ManageLiveStream extends ClientSDK {
|
|
|
25
25
|
*
|
|
26
26
|
* Suppose a news agency is broadcasting a live event and wants to track the configurations set for the live stream while also checking the stream's status.
|
|
27
27
|
*
|
|
28
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
28
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
29
29
|
*/
|
|
30
30
|
get(request: operations.GetLiveStreamByIdRequest, options?: RequestOptions): Promise<operations.GetLiveStreamByIdResponse>;
|
|
31
31
|
/**
|
|
@@ -34,13 +34,13 @@ export declare class ManageLiveStream extends ClientSDK {
|
|
|
34
34
|
* @remarks
|
|
35
35
|
* This endpoint allows you to modify the parameters of an existing live stream, such as its `metadata` (title, description) or the `reconnectWindow`. It’s useful for making changes to a stream that has already been created but not yet ended. After the live stream is disabled, you cannot update a stream.
|
|
36
36
|
*
|
|
37
|
-
* The updated stream parameters and the `streamId` needs to be shared in the request, and FastPix returns the updated stream details. After the update, <a href="https://docs.fastpix.
|
|
37
|
+
* The updated stream parameters and the `streamId` needs to be shared in the request, and FastPix returns the updated stream details. After the update, <a href="https://docs.fastpix.com/docs/live-events#videolive_streamupdated">video.live_stream.updated</a> webhook event notifies your system.
|
|
38
38
|
*
|
|
39
39
|
* #### Example
|
|
40
40
|
*
|
|
41
41
|
* A host realizes they need to extend the reconnect window for their live stream in case they lose connection temporarily during the event. Or suppose during a multi-day online conference, the event organizers need to update the stream title to reflect the next day"s session while keeping the same stream ID for continuity.
|
|
42
42
|
*
|
|
43
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
43
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
44
44
|
*/
|
|
45
45
|
update(request: operations.UpdateLiveStreamRequest, options?: RequestOptions): Promise<operations.UpdateLiveStreamResponse>;
|
|
46
46
|
/**
|
|
@@ -55,7 +55,7 @@ export declare class ManageLiveStream extends ClientSDK {
|
|
|
55
55
|
*
|
|
56
56
|
* A speaker finishes their live session and wants to prevent the stream from being mistakenly started again. By calling this endpoint, the stream is transitioned to a `disabled` state, ensuring it's permanently stopped (unless re-enabled on a paid plan).
|
|
57
57
|
*
|
|
58
|
-
* Related guide <a href="https://docs.fastpix.
|
|
58
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
59
59
|
*/
|
|
60
60
|
disable(request: operations.DisableLiveStreamRequest, options?: RequestOptions): Promise<operations.DisableLiveStreamResponse>;
|
|
61
61
|
/**
|
|
@@ -72,7 +72,7 @@ export declare class ManageLiveStream extends ClientSDK {
|
|
|
72
72
|
*
|
|
73
73
|
* A virtual event ends, and the system or host needs to close the livestream to prevent further streaming. This endpoint ensures the livestream status is changed from `active` to `idle`, indicating it's officially completed.
|
|
74
74
|
*
|
|
75
|
-
* Related guide <a href="https://docs.fastpix.
|
|
75
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
76
76
|
*/
|
|
77
77
|
complete(request: operations.CompleteLiveStreamRequest, options?: RequestOptions): Promise<operations.CompleteLiveStreamResponse>;
|
|
78
78
|
}
|
|
@@ -26,7 +26,7 @@ class ManageLiveStream extends sdks_js_1.ClientSDK {
|
|
|
26
26
|
*
|
|
27
27
|
* Suppose a content creator is hosting a live concert and wants to display the number of live viewers on their dashboard. This endpoint can be queried to show up-to-date viewer statistics.
|
|
28
28
|
*
|
|
29
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
29
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
30
30
|
*/
|
|
31
31
|
async getViewerCount(request, options) {
|
|
32
32
|
return (0, fp_js_1.unwrapAsync)((0, manageLiveStreamGetViewerCount_js_1.manageLiveStreamGetViewerCount)(this, request, options));
|
|
@@ -40,7 +40,7 @@ class ManageLiveStream extends sdks_js_1.ClientSDK {
|
|
|
40
40
|
*
|
|
41
41
|
* Suppose a news agency is broadcasting a live event and wants to track the configurations set for the live stream while also checking the stream's status.
|
|
42
42
|
*
|
|
43
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
43
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
44
44
|
*/
|
|
45
45
|
async get(request, options) {
|
|
46
46
|
return (0, fp_js_1.unwrapAsync)((0, manageLiveStreamGet_js_1.manageLiveStreamGet)(this, request, options));
|
|
@@ -51,13 +51,13 @@ class ManageLiveStream extends sdks_js_1.ClientSDK {
|
|
|
51
51
|
* @remarks
|
|
52
52
|
* This endpoint allows you to modify the parameters of an existing live stream, such as its `metadata` (title, description) or the `reconnectWindow`. It’s useful for making changes to a stream that has already been created but not yet ended. After the live stream is disabled, you cannot update a stream.
|
|
53
53
|
*
|
|
54
|
-
* The updated stream parameters and the `streamId` needs to be shared in the request, and FastPix returns the updated stream details. After the update, <a href="https://docs.fastpix.
|
|
54
|
+
* The updated stream parameters and the `streamId` needs to be shared in the request, and FastPix returns the updated stream details. After the update, <a href="https://docs.fastpix.com/docs/live-events#videolive_streamupdated">video.live_stream.updated</a> webhook event notifies your system.
|
|
55
55
|
*
|
|
56
56
|
* #### Example
|
|
57
57
|
*
|
|
58
58
|
* A host realizes they need to extend the reconnect window for their live stream in case they lose connection temporarily during the event. Or suppose during a multi-day online conference, the event organizers need to update the stream title to reflect the next day"s session while keeping the same stream ID for continuity.
|
|
59
59
|
*
|
|
60
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
60
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
61
61
|
*/
|
|
62
62
|
async update(request, options) {
|
|
63
63
|
return (0, fp_js_1.unwrapAsync)((0, manageLiveStreamUpdate_js_1.manageLiveStreamUpdate)(this, request, options));
|
|
@@ -74,7 +74,7 @@ class ManageLiveStream extends sdks_js_1.ClientSDK {
|
|
|
74
74
|
*
|
|
75
75
|
* A speaker finishes their live session and wants to prevent the stream from being mistakenly started again. By calling this endpoint, the stream is transitioned to a `disabled` state, ensuring it's permanently stopped (unless re-enabled on a paid plan).
|
|
76
76
|
*
|
|
77
|
-
* Related guide <a href="https://docs.fastpix.
|
|
77
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
78
78
|
*/
|
|
79
79
|
async disable(request, options) {
|
|
80
80
|
return (0, fp_js_1.unwrapAsync)((0, manageLiveStreamDisable_js_1.manageLiveStreamDisable)(this, request, options));
|
|
@@ -93,7 +93,7 @@ class ManageLiveStream extends sdks_js_1.ClientSDK {
|
|
|
93
93
|
*
|
|
94
94
|
* A virtual event ends, and the system or host needs to close the livestream to prevent further streaming. This endpoint ensures the livestream status is changed from `active` to `idle`, indicating it's officially completed.
|
|
95
95
|
*
|
|
96
|
-
* Related guide <a href="https://docs.fastpix.
|
|
96
|
+
* Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
|
|
97
97
|
*/
|
|
98
98
|
async complete(request, options) {
|
|
99
99
|
return (0, fp_js_1.unwrapAsync)((0, manageLiveStreamComplete_js_1.manageLiveStreamComplete)(this, request, options));
|
|
@@ -15,7 +15,7 @@ export declare class ManageVideos extends ClientSDK {
|
|
|
15
15
|
* - **status** – Indicates whether the media is still *Processing* or has transitioned to *Ready*.
|
|
16
16
|
* - **playbackId** – A unique identifier that allows you to stream the media once it is *Ready*.
|
|
17
17
|
* You can construct the stream URL as follows:
|
|
18
|
-
* `https://stream.fastpix.
|
|
18
|
+
* `https://stream.fastpix.com/<playbackId>.m3u8`
|
|
19
19
|
*
|
|
20
20
|
* #### Example
|
|
21
21
|
*
|
|
@@ -36,7 +36,7 @@ export declare class ManageVideos extends ClientSDK {
|
|
|
36
36
|
*
|
|
37
37
|
* 3. The response returns the updated media data, confirming the changes.
|
|
38
38
|
*
|
|
39
|
-
* 4. Monitor the <a href="https://docs.fastpix.
|
|
39
|
+
* 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.
|
|
40
40
|
*
|
|
41
41
|
* #### Example
|
|
42
42
|
* 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.
|
|
@@ -54,7 +54,7 @@ export declare class ManageVideos extends ClientSDK {
|
|
|
54
54
|
*
|
|
55
55
|
* 2. This action is irreversible. Make sure you no longer need the media before proceeding. Once deleted, the media can’t be retrieved or played back.
|
|
56
56
|
*
|
|
57
|
-
* 3. Monitor the following webhook event: <a href="https://docs.fastpix.
|
|
57
|
+
* 3. Monitor the following webhook event: <a href="https://docs.fastpix.com/docs/media-events#videomediadeleted">video.media.deleted</a>
|
|
58
58
|
*
|
|
59
59
|
* #### Example
|
|
60
60
|
* A user on a video-sharing platform decides to remove an old video from their profile, or suppose you're running a content moderation system, and one of the videos uploaded by a user violates your platform's policies. Using this endpoint, the media is permanently deleted from your library, ensuring it's no longer accessible or viewable by other users.
|
|
@@ -76,16 +76,16 @@ export declare class ManageVideos extends ClientSDK {
|
|
|
76
76
|
*
|
|
77
77
|
* #### Webhook events
|
|
78
78
|
*
|
|
79
|
-
* 1. After successfully adding a track, your system must receive the webhook event <a href="https://docs.fastpix.
|
|
79
|
+
* 1. After successfully adding a track, your system must receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediatrackcreated">video.media.track.created</a>.
|
|
80
80
|
*
|
|
81
|
-
* 2. Once the track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.
|
|
81
|
+
* 2. Once the 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>.
|
|
82
82
|
*
|
|
83
|
-
* 3. Finally, an update event <a href="https://docs.fastpix.
|
|
83
|
+
* 3. Finally, an update event <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> must notify your system about the media's updated status.
|
|
84
84
|
*
|
|
85
85
|
* #### Example
|
|
86
|
-
* Suppose you have a video uploaded to the FastPix platform, and you want to add an Italian audio track to it. By calling this API, you can attach an external audio file (https://static.fastpix.
|
|
86
|
+
* Suppose you have a video uploaded to the FastPix platform, and you want to add an Italian audio track to it. By calling this API, you can attach an external audio file (https://static.fastpix.com/music-1.mp3) to the media file. Similarly, if you need to add subtitles in different languages, you can specify type: `subtitle` with the corresponding subtitle `url`, `languageCode` and `languageName`.
|
|
87
87
|
*
|
|
88
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
88
|
+
* 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>
|
|
89
89
|
*/
|
|
90
90
|
addTrack(request: operations.AddMediaTrackRequest, options?: RequestOptions): Promise<operations.AddMediaTrackResponse>;
|
|
91
91
|
/**
|
|
@@ -101,7 +101,7 @@ export declare class ManageVideos extends ClientSDK {
|
|
|
101
101
|
*
|
|
102
102
|
* #### Webhook Events
|
|
103
103
|
*
|
|
104
|
-
* Once the upload is cancelled, you must receive the webhook event <a href="https://docs.fastpix.
|
|
104
|
+
* Once the upload is cancelled, you must receive the webhook event <a href="https://docs.fastpix.com/docs/media-events#videomediauploadcancelled">video.media.upload.cancelled</a>.
|
|
105
105
|
*
|
|
106
106
|
* #### Example
|
|
107
107
|
*
|
|
@@ -126,11 +126,11 @@ export declare class ManageVideos extends ClientSDK {
|
|
|
126
126
|
*
|
|
127
127
|
* After updating a track, your system must receive webhook notifications:
|
|
128
128
|
*
|
|
129
|
-
* 1. After successfully updating a track, your system must receive the webhook event <a href="https://docs.fastpix.
|
|
129
|
+
* 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>.
|
|
130
130
|
*
|
|
131
|
-
* 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.
|
|
131
|
+
* 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>.
|
|
132
132
|
*
|
|
133
|
-
* 3. Once the media file is updated with the new track details, a <a href="https://docs.fastpix.
|
|
133
|
+
* 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.
|
|
134
134
|
*
|
|
135
135
|
* #### Example
|
|
136
136
|
* 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:
|
|
@@ -138,7 +138,7 @@ export declare class ManageVideos extends ClientSDK {
|
|
|
138
138
|
* - The original track file has errors and needs correction.
|
|
139
139
|
* - You want to improve subtitle translations or replace an audio track with a better-quality version.
|
|
140
140
|
*
|
|
141
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
141
|
+
* 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>
|
|
142
142
|
*/
|
|
143
143
|
updateTrack(request: operations.UpdateMediaTrackRequest, options?: RequestOptions): Promise<operations.UpdateMediaTrackResponse>;
|
|
144
144
|
/**
|
|
@@ -157,11 +157,11 @@ export declare class ManageVideos extends ClientSDK {
|
|
|
157
157
|
*
|
|
158
158
|
* #### Webhook Events
|
|
159
159
|
*
|
|
160
|
-
* 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://docs.fastpix.
|
|
160
|
+
* 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>.
|
|
161
161
|
*
|
|
162
|
-
* 2. Finally the <a href="https://docs.fastpix.
|
|
162
|
+
* 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.
|
|
163
163
|
*
|
|
164
|
-
* </br> Related guide: <a href="https://docs.fastpix.
|
|
164
|
+
* </br> Related guide: <a href="https://docs.fastpix.com/docs/add-auto-generated-subtitles-to-videos">Add auto-generated subtitles</a>
|
|
165
165
|
*/
|
|
166
166
|
generateSubtitleTrack(request: operations.GenerateSubtitleTrackRequest, options?: RequestOptions): Promise<operations.GenerateSubtitleTrackResponse>;
|
|
167
167
|
/**
|
|
@@ -208,12 +208,12 @@ export declare class ManageVideos extends ClientSDK {
|
|
|
208
208
|
*
|
|
209
209
|
* #### Webhook events
|
|
210
210
|
*
|
|
211
|
-
* - <a href="https://docs.fastpix.
|
|
211
|
+
* - <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.
|
|
212
212
|
*
|
|
213
213
|
* #### Example
|
|
214
|
-
* 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.
|
|
214
|
+
* 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.
|
|
215
215
|
*
|
|
216
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
216
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>
|
|
217
217
|
*/
|
|
218
218
|
updateMp4Support(request: operations.UpdatedMp4SupportRequest, options?: RequestOptions): Promise<operations.UpdatedMp4SupportResponse>;
|
|
219
219
|
/**
|
|
@@ -34,7 +34,7 @@ class ManageVideos extends sdks_js_1.ClientSDK {
|
|
|
34
34
|
* - **status** – Indicates whether the media is still *Processing* or has transitioned to *Ready*.
|
|
35
35
|
* - **playbackId** – A unique identifier that allows you to stream the media once it is *Ready*.
|
|
36
36
|
* You can construct the stream URL as follows:
|
|
37
|
-
* `https://stream.fastpix.
|
|
37
|
+
* `https://stream.fastpix.com/<playbackId>.m3u8`
|
|
38
38
|
*
|
|
39
39
|
* #### Example
|
|
40
40
|
*
|
|
@@ -57,7 +57,7 @@ class ManageVideos extends sdks_js_1.ClientSDK {
|
|
|
57
57
|
*
|
|
58
58
|
* 3. The response returns the updated media data, confirming the changes.
|
|
59
59
|
*
|
|
60
|
-
* 4. Monitor the <a href="https://docs.fastpix.
|
|
60
|
+
* 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.
|
|
61
61
|
*
|
|
62
62
|
* #### Example
|
|
63
63
|
* 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.
|
|
@@ -77,7 +77,7 @@ class ManageVideos extends sdks_js_1.ClientSDK {
|
|
|
77
77
|
*
|
|
78
78
|
* 2. This action is irreversible. Make sure you no longer need the media before proceeding. Once deleted, the media can’t be retrieved or played back.
|
|
79
79
|
*
|
|
80
|
-
* 3. Monitor the following webhook event: <a href="https://docs.fastpix.
|
|
80
|
+
* 3. Monitor the following webhook event: <a href="https://docs.fastpix.com/docs/media-events#videomediadeleted">video.media.deleted</a>
|
|
81
81
|
*
|
|
82
82
|
* #### Example
|
|
83
83
|
* A user on a video-sharing platform decides to remove an old video from their profile, or suppose you're running a content moderation system, and one of the videos uploaded by a user violates your platform's policies. Using this endpoint, the media is permanently deleted from your library, ensuring it's no longer accessible or viewable by other users.
|
|
@@ -101,16 +101,16 @@ class ManageVideos extends sdks_js_1.ClientSDK {
|
|
|
101
101
|
*
|
|
102
102
|
* #### Webhook events
|
|
103
103
|
*
|
|
104
|
-
* 1. After successfully adding a track, your system must receive the webhook event <a href="https://docs.fastpix.
|
|
104
|
+
* 1. After successfully adding a track, your system must receive the webhook event <a href="https://docs.fastpix.com/docs/transform-media-events#videomediatrackcreated">video.media.track.created</a>.
|
|
105
105
|
*
|
|
106
|
-
* 2. Once the track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.
|
|
106
|
+
* 2. Once the 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>.
|
|
107
107
|
*
|
|
108
|
-
* 3. Finally, an update event <a href="https://docs.fastpix.
|
|
108
|
+
* 3. Finally, an update event <a href="https://docs.fastpix.com/docs/media-events#videomediaupdated">video.media.updated</a> must notify your system about the media's updated status.
|
|
109
109
|
*
|
|
110
110
|
* #### Example
|
|
111
|
-
* Suppose you have a video uploaded to the FastPix platform, and you want to add an Italian audio track to it. By calling this API, you can attach an external audio file (https://static.fastpix.
|
|
111
|
+
* Suppose you have a video uploaded to the FastPix platform, and you want to add an Italian audio track to it. By calling this API, you can attach an external audio file (https://static.fastpix.com/music-1.mp3) to the media file. Similarly, if you need to add subtitles in different languages, you can specify type: `subtitle` with the corresponding subtitle `url`, `languageCode` and `languageName`.
|
|
112
112
|
*
|
|
113
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
113
|
+
* 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>
|
|
114
114
|
*/
|
|
115
115
|
async addTrack(request, options) {
|
|
116
116
|
return (0, fp_js_1.unwrapAsync)((0, manageVideosAddTrack_js_1.manageVideosAddTrack)(this, request, options));
|
|
@@ -128,7 +128,7 @@ class ManageVideos extends sdks_js_1.ClientSDK {
|
|
|
128
128
|
*
|
|
129
129
|
* #### Webhook Events
|
|
130
130
|
*
|
|
131
|
-
* Once the upload is cancelled, you must receive the webhook event <a href="https://docs.fastpix.
|
|
131
|
+
* Once the upload is cancelled, you must receive the webhook event <a href="https://docs.fastpix.com/docs/media-events#videomediauploadcancelled">video.media.upload.cancelled</a>.
|
|
132
132
|
*
|
|
133
133
|
* #### Example
|
|
134
134
|
*
|
|
@@ -155,11 +155,11 @@ class ManageVideos extends sdks_js_1.ClientSDK {
|
|
|
155
155
|
*
|
|
156
156
|
* After updating a track, your system must receive webhook notifications:
|
|
157
157
|
*
|
|
158
|
-
* 1. After successfully updating a track, your system must receive the webhook event <a href="https://docs.fastpix.
|
|
158
|
+
* 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>.
|
|
159
159
|
*
|
|
160
|
-
* 2. Once the new track is processed and ready, you must receive the webhook event <a href="https://docs.fastpix.
|
|
160
|
+
* 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>.
|
|
161
161
|
*
|
|
162
|
-
* 3. Once the media file is updated with the new track details, a <a href="https://docs.fastpix.
|
|
162
|
+
* 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.
|
|
163
163
|
*
|
|
164
164
|
* #### Example
|
|
165
165
|
* 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:
|
|
@@ -167,7 +167,7 @@ class ManageVideos extends sdks_js_1.ClientSDK {
|
|
|
167
167
|
* - The original track file has errors and needs correction.
|
|
168
168
|
* - You want to improve subtitle translations or replace an audio track with a better-quality version.
|
|
169
169
|
*
|
|
170
|
-
* Related guides: <a href="https://docs.fastpix.
|
|
170
|
+
* 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>
|
|
171
171
|
*/
|
|
172
172
|
async updateTrack(request, options) {
|
|
173
173
|
return (0, fp_js_1.unwrapAsync)((0, manageVideosUpdateTrack_js_1.manageVideosUpdateTrack)(this, request, options));
|
|
@@ -188,11 +188,11 @@ class ManageVideos extends sdks_js_1.ClientSDK {
|
|
|
188
188
|
*
|
|
189
189
|
* #### Webhook Events
|
|
190
190
|
*
|
|
191
|
-
* 1. After the subtitle track is generated and ready, you receive the webhook event <a href="https://docs.fastpix.
|
|
191
|
+
* 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>.
|
|
192
192
|
*
|
|
193
|
-
* 2. Finally the <a href="https://docs.fastpix.
|
|
193
|
+
* 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.
|
|
194
194
|
*
|
|
195
|
-
* </br> Related guide: <a href="https://docs.fastpix.
|
|
195
|
+
* </br> Related guide: <a href="https://docs.fastpix.com/docs/add-auto-generated-subtitles-to-videos">Add auto-generated subtitles</a>
|
|
196
196
|
*/
|
|
197
197
|
async generateSubtitleTrack(request, options) {
|
|
198
198
|
return (0, fp_js_1.unwrapAsync)((0, manageVideosGenerateSubtitleTrack_js_1.manageVideosGenerateSubtitleTrack)(this, request, options));
|
|
@@ -243,12 +243,12 @@ class ManageVideos extends sdks_js_1.ClientSDK {
|
|
|
243
243
|
*
|
|
244
244
|
* #### Webhook events
|
|
245
245
|
*
|
|
246
|
-
* - <a href="https://docs.fastpix.
|
|
246
|
+
* - <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.
|
|
247
247
|
*
|
|
248
248
|
* #### Example
|
|
249
|
-
* 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.
|
|
249
|
+
* 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.
|
|
250
250
|
*
|
|
251
|
-
* Related guide: <a href="https://docs.fastpix.
|
|
251
|
+
* Related guide: <a href="https://docs.fastpix.com/docs/mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>
|
|
252
252
|
*/
|
|
253
253
|
async updateMp4Support(request, options) {
|
|
254
254
|
return (0, fp_js_1.unwrapAsync)((0, manageVideosUpdateMp4Support_js_1.manageVideosUpdateMp4Support)(this, request, options));
|