Skip to content

Escolhe um dos quadros do vídeo como capa

PUT/api/media/{id}/cover

Auth
Requires a token
API key:
media:write
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Depois do envio, todo vídeo (até 512 MB) é medido e ganha em segundo plano até **6 quadros candidatos** a capa, espalhados pela duração (os quase pretos ficam de fora quando há outros), e o primeiro bom perto de 25% vira a capa automática. Quem pode escolher a capa recebe os quadros em `coverCandidates` (e o atual em `coverCandidateIndex`) no `GET /api/media/{id}/url`.

Aqui a pessoa escolhe um deles pelo índice. Uma imagem de capa enviada antes (`posterMediaId`) é removida e apagada, para o quadro aparecer. Mesmas regras de quem pode do `PUT /api/media/{id}/poster`: só quem enviou o vídeo e, com o vídeo já num post ou comentário, só se também for o autor (a equipe, para gravação de evento ou aula): 403. Vídeo cujos quadros ainda não ficaram prontos (ou enviado antes desta função): 409; índice fora da lista: 400. Devolve o vídeo assinado, com os candidatos.

Parameters

NameInTypeDescription
idrequiredpathstring (uuid)O vídeo.

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request body application/json

NameTypeDescription
candidaterequiredintegerO índice do quadro em `coverCandidates`. · ≥ 0, ≤ 5

Responses

StatusDescription
200Capa atualizada; o vídeo assinado.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Os quadros do vídeo ainda não ficaram prontos.
500Erro interno do servidor.

curl example

curl -X PUT "https://api.memberfy.net/api/media/<id>/cover" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"candidate":0}'