RegisterMedia - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Après avoir stocké un fichier audio ou vidéo dans un bucket Object Storage Service (OSS) utilisé pour ApsaraVideo VOD, appelez l'opération RegisterMedia pour enregistrer le fichier multimédia. Une fois le fichier enregistré, utilisez l'ID multimédia associé pour soumettre des tâches de transcodage et de capture d'écran dans ApsaraVideo VOD. Pour plus d'informations, consultez les rubriques SubmitTranscodeJobs et SubmitSnapshotJob.

Remarque

Vous pouvez enregistrer jusqu'à 10 fichiers multimédias OSS ayant le même emplacement de stockage en une seule fois.
Si vous téléchargez un fichier multimédia via la console ApsaraVideo VOD sans spécifier d'ID de groupe de modèles de transcodage, le service utilise le groupe de modèles par défaut. En revanche, si vous n'indiquez pas cet ID lors de l'appel à l'opération RegisterMedia, ApsaraVideo VOD ne transcode pas automatiquement le fichier après son enregistrement. Si vous spécifiez un ID de groupe de modèles, le service utilise ce groupe pour le transcodage.
Si le fichier multimédia que vous souhaitez enregistrer l'a déjà été, cette opération renvoie uniquement l'ID multimédia unique associé au fichier. Aucun autre traitement n'est effectué.

Limite QPS

Vous pouvez appeler cette opération jusqu'à 50 fois par seconde par compte. Si le nombre d'appels par seconde dépasse cette limite, un mécanisme de limitation du débit (throttling) se déclenche, ce qui peut affecter votre activité. Nous vous recommandons de prendre en compte cette limite lors de l'utilisation de cette opération. Pour plus d'informations, consultez la rubrique Limites QPS des API dans ApsaraVideo VOD.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	RegisterMedia	L'opération à effectuer. Définissez la valeur sur RegisterMedia.
RegisterMetadatas	String	Oui	[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]	Les métadonnées du fichier multimédia à enregistrer. La valeur est une chaîne JSON. Vous pouvez spécifier les métadonnées pour un maximum de 10 fichiers multimédias à la fois. Pour plus d'informations sur les métadonnées des fichiers multimédias, consultez la section RegisterMetadata de cette rubrique.
TemplateGroupId	String	Non	ca3a8f6e49c87b65806709586****	L'ID du groupe de modèles de transcodage. Utilisez l'une des méthodes suivantes pour obtenir l'ID du groupe de modèles : Connectez-vous à la console ApsaraVideo VOD. Dans le volet de navigation de gauche, choisissez Configuration Management > Media Processing > Transcoding Template Groups. Sur la page Transcoding Template Groups, vous pouvez consulter l'ID du groupe de modèles de transcodage. Consultez la valeur du paramètre TranscodeTemplateGroupId renvoyée par l'opération AddTranscodeTemplateGroup appelée pour créer un groupe de modèles de transcodage. Consultez la valeur du paramètre TranscodeTemplateGroupId renvoyée par l'opération ListTranscodeTemplateGroup appelée pour interroger un groupe de modèles de transcodage. Remarque Si vous n'avez pas besoin de transcoder le fichier multimédia, définissez le paramètre TemplateGroupId sur VOD_NO_TRANSCODE. Sinon, une exception se produira lors de la lecture vidéo. Si vous devez transcoder le fichier, spécifiez l'ID du groupe de modèles de transcodage. Si les paramètres WorkflowId et TemplateGroupId sont tous deux définis, la valeur du paramètre WorkflowId prend effet. Pour plus d'informations, consultez la rubrique Workflows.
UserData	String	Non	null	Les configurations personnalisées, telles que les configurations de rappel. La valeur est une chaîne JSON. Pour plus d'informations, consultez la section « UserData : spécifie les configurations personnalisées pour le téléchargement de médias » de la rubrique Paramètres de requête.
WorkflowId	String	Non	637adc2b7ba51a83d841606f8****	L'ID du workflow. Pour afficher l'ID du workflow, connectez-vous à la console ApsaraVideo VOD. Dans le volet de navigation de gauche, choisissez Configuration Management > Media Processing > Workflows. Remarque Si les paramètres WorkflowId et TemplateGroupId sont tous deux définis, la valeur du paramètre WorkflowId prend effet. Pour plus d'informations, consultez la rubrique Workflows.

RegisterMetadata

Le tableau suivant décrit les métadonnées du fichier multimédia à enregistrer.

Paramètre	Type	Obligatoire	Description
FileURL	String	Oui	L'URL OSS du fichier source. Appelez l'opération GetMezzanineInfo pour obtenir l'URL OSS du fichier source. L'URL peut contenir jusqu'à 1 024 octets. Le nom du fichier doit être globalement unique. Si le fichier multimédia à enregistrer l'a déjà été, l'ID multimédia unique associé au fichier est renvoyé.
Title	String	Oui	Le titre du fichier multimédia. Le titre peut contenir jusqu'à 128 octets. La valeur doit être encodée en UTF-8.
Description	String	Non	La description du fichier multimédia. La description peut contenir jusqu'à 1 024 octets. La valeur doit être encodée en UTF-8.
Tags	String	Non	Un ou plusieurs tags associés au fichier multimédia. Chaque tag peut contenir jusqu'à 32 octets. Vous pouvez spécifier un maximum de 16 tags. Séparez les tags par des virgules (,). La valeur doit être encodée en UTF-8.
CoverURL	String	Non	L'URL de la vignette. L'URL peut contenir jusqu'à 1 024 octets.
CateId	Long	Non	L'ID de catégorie du fichier multimédia. Utilisez l'une des méthodes suivantes pour obtenir l'ID de catégorie : Connectez-vous à la console ApsaraVideo VOD. Dans le volet de navigation de gauche, choisissez Configuration Management > Media Management > Categories. Sur la page Categories, vous pouvez consulter l'ID de catégorie du fichier multimédia. Consultez la valeur du paramètre CateId renvoyée par l'opération AddCategory appelée pour créer une catégorie. Consultez la valeur du paramètre CateId renvoyée par l'opération GetCategories appelée pour interroger une catégorie.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	14F43C5C-8033-448B-AD04F64E5098****	L'ID de la requête.
FailedFileURLs	Array of String	["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]	Les URL des fichiers multimédias dont l'enregistrement a échoué.
RegisteredMediaList	Array of RegisteredMedia		Les fichiers multimédias enregistrés, incluant les nouveaux enregistrements et les enregistrements répétés.
NewRegister	Boolean	false	Indique si le fichier multimédia est nouvellement enregistré ou s'il s'agit d'un enregistrement répété. Valeurs possibles : true : Le fichier multimédia est nouvellement enregistré. false : Le fichier multimédia est enregistré de manière répétée.
FileURL	String	http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4	L'URL OSS du fichier multimédia.
MediaId	String	d97af32828084d1896683b1aa38****	L'ID du fichier multimédia enregistré dans ApsaraVideo VOD. Si le fichier multimédia enregistré est un fichier audio ou vidéo, la valeur du paramètre VideoId renvoyée par ApsaraVideo VOD prend effet.

Exemples

Exemple de requête

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=RegisterMedia
&RegisterMetadatas=[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]
&UserData={"Extend":{"localId":"****","test":"www"}}
&WorkflowId=637adc2b7ba51a83d841606f8****
&<Common request parameters>

Exemple de réponse réussie

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<RegisterMediaResponse>
    <RequestId>14F43C5C-8033-43E7-B48B-AD04F64E5098</RequestId>
    <RegisteredMediaList>
        <MediaId>d97af328280842229aed1896683b1aa38</MediaId>
        <FileURL>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4</FileURL>
        <NewRegister>true</NewRegister>
    </RegisteredMediaList>
    <RegisteredMediaList>
        <MediaId>d97af328280842229aed1896683b1aa38</MediaId>
        <FileURL>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_02.mp4</FileURL>
        <NewRegister>false</NewRegister>
    </RegisteredMediaList>
    <FailedFileURLs>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4</FailedFileURLs>
</RegisterMediaResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "14F43C5C-8033-43E7-B48B-AD04F64E5098",
  "RegisteredMediaList" : [ {
    "MediaId" : "d97af328280842229aed1896683b1aa38",
    "FileURL" : "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4",
    "NewRegister" : true
  }, {
    "MediaId" : "d97af328280842229aed1896683b1aa38",
    "FileURL" : "http://*****.oss-cn-shanghai.aliyuncs.com/vod_sample_02.mp4",
    "NewRegister" : false
  } ],
  "FailedFileURLs" : [ "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4" ]
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs de l'API.