X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=shared%2Fmodels%2Fserver%2Fjob.model.ts;h=9c0b5ea569256851d6587ab5900dcdcdf66b10bd;hb=ca68986083edfc530985f47007a099b94cd65325;hp=19fd4c65924531b14505bb9b0dd34bef590cdf0e;hpb=b764380ac23f4e9d4677d08acdc3474c2931a16d;p=github%2FChocobozzz%2FPeerTube.git diff --git a/shared/models/server/job.model.ts b/shared/models/server/job.model.ts index 19fd4c659..9c0b5ea56 100644 --- a/shared/models/server/job.model.ts +++ b/shared/models/server/job.model.ts @@ -1,24 +1,260 @@ -export type JobState = 'active' | 'completed' | 'failed' | 'waiting' | 'delayed' - -export type JobType = 'activitypub-http-unicast' | - 'activitypub-http-broadcast' | - 'activitypub-http-fetcher' | - 'activitypub-follow' | - 'video-file-import' | - 'video-transcoding' | - 'email' | - 'video-import' | - 'videos-views' | - 'activitypub-refresher' | - 'video-redundancy' +import { ContextType } from '../activitypub/context' +import { VideoState } from '../videos' +import { VideoResolution } from '../videos/file/video-resolution.enum' +import { VideoStudioTaskCut } from '../videos/studio' +import { SendEmailOptions } from './emailer.model' + +export type JobState = 'active' | 'completed' | 'failed' | 'waiting' | 'delayed' | 'paused' | 'waiting-children' + +export type JobType = + | 'activitypub-cleaner' + | 'activitypub-follow' + | 'activitypub-http-broadcast-parallel' + | 'activitypub-http-broadcast' + | 'activitypub-http-fetcher' + | 'activitypub-http-unicast' + | 'activitypub-refresher' + | 'actor-keys' + | 'after-video-channel-import' + | 'email' + | 'federate-video' + | 'manage-video-torrent' + | 'move-to-object-storage' + | 'notify' + | 'video-channel-import' + | 'video-file-import' + | 'video-import' + | 'video-live-ending' + | 'video-redundancy' + | 'video-studio-edition' + | 'video-transcoding' + | 'videos-views-stats' export interface Job { - id: number - state: JobState + id: number | string + state: JobState | 'unknown' type: JobType - data: any, - error: any, + data: any + priority: number + progress: number + error: any createdAt: Date | string finishedOn: Date | string processedOn: Date | string } + +export type ActivitypubHttpBroadcastPayload = { + uris: string[] + contextType: ContextType + body: any + signatureActorId?: number +} + +export type ActivitypubFollowPayload = { + followerActorId: number + name: string + host: string + isAutoFollow?: boolean + assertIsChannel?: boolean +} + +export type FetchType = 'activity' | 'video-shares' | 'video-comments' | 'account-playlists' +export type ActivitypubHttpFetcherPayload = { + uri: string + type: FetchType + videoId?: number +} + +export type ActivitypubHttpUnicastPayload = { + uri: string + contextType: ContextType + signatureActorId?: number + body: object +} + +export type RefreshPayload = { + type: 'video' | 'video-playlist' | 'actor' + url: string +} + +export type EmailPayload = SendEmailOptions + +export type VideoFileImportPayload = { + videoUUID: string + filePath: string +} + +// --------------------------------------------------------------------------- + +export type VideoImportTorrentPayloadType = 'magnet-uri' | 'torrent-file' +export type VideoImportYoutubeDLPayloadType = 'youtube-dl' + +export interface VideoImportYoutubeDLPayload { + type: VideoImportYoutubeDLPayloadType + videoImportId: number + + fileExt?: string +} + +export interface VideoImportTorrentPayload { + type: VideoImportTorrentPayloadType + videoImportId: number +} + +export type VideoImportPayload = (VideoImportYoutubeDLPayload | VideoImportTorrentPayload) & { + preventException: boolean +} + +export interface VideoImportPreventExceptionResult { + resultType: 'success' | 'error' +} + +// --------------------------------------------------------------------------- + +export type VideoRedundancyPayload = { + videoId: number +} + +export type ManageVideoTorrentPayload = + { + action: 'create' + videoId: number + videoFileId: number + } | { + action: 'update-metadata' + + videoId?: number + streamingPlaylistId?: number + + videoFileId: number + } + +// Video transcoding payloads + +interface BaseTranscodingPayload { + videoUUID: string + isNewVideo?: boolean +} + +export interface HLSTranscodingPayload extends BaseTranscodingPayload { + type: 'new-resolution-to-hls' + resolution: VideoResolution + copyCodecs: boolean + + hasAudio: boolean + + autoDeleteWebTorrentIfNeeded: boolean + isMaxQuality: boolean +} + +export interface NewWebTorrentResolutionTranscodingPayload extends BaseTranscodingPayload { + type: 'new-resolution-to-webtorrent' + resolution: VideoResolution + + hasAudio: boolean + createHLSIfNeeded: boolean +} + +export interface MergeAudioTranscodingPayload extends BaseTranscodingPayload { + type: 'merge-audio-to-webtorrent' + resolution: VideoResolution + createHLSIfNeeded: true +} + +export interface OptimizeTranscodingPayload extends BaseTranscodingPayload { + type: 'optimize-to-webtorrent' +} + +export type VideoTranscodingPayload = + HLSTranscodingPayload + | NewWebTorrentResolutionTranscodingPayload + | OptimizeTranscodingPayload + | MergeAudioTranscodingPayload + +export interface VideoLiveEndingPayload { + videoId: number + publishedAt: string + liveSessionId: number + streamingPlaylistId: number + + replayDirectory?: string +} + +export interface ActorKeysPayload { + actorId: number +} + +export interface DeleteResumableUploadMetaFilePayload { + filepath: string +} + +export interface MoveObjectStoragePayload { + videoUUID: string + isNewVideo: boolean + previousVideoState: VideoState +} + +export type VideoStudioTaskCutPayload = VideoStudioTaskCut + +export type VideoStudioTaskIntroPayload = { + name: 'add-intro' + + options: { + file: string + } +} + +export type VideoStudioTaskOutroPayload = { + name: 'add-outro' + + options: { + file: string + } +} + +export type VideoStudioTaskWatermarkPayload = { + name: 'add-watermark' + + options: { + file: string + } +} + +export type VideoStudioTaskPayload = + VideoStudioTaskCutPayload | + VideoStudioTaskIntroPayload | + VideoStudioTaskOutroPayload | + VideoStudioTaskWatermarkPayload + +export interface VideoStudioEditionPayload { + videoUUID: string + tasks: VideoStudioTaskPayload[] +} + +// --------------------------------------------------------------------------- + +export interface VideoChannelImportPayload { + externalChannelUrl: string + videoChannelId: number + + partOfChannelSyncId?: number +} + +export interface AfterVideoChannelImportPayload { + channelSyncId: number +} + +// --------------------------------------------------------------------------- + +export type NotifyPayload = + { + action: 'new-video' + videoUUID: string + } + +// --------------------------------------------------------------------------- + +export interface FederateVideoPayload { + videoUUID: string + isNewVideo: boolean +}