Documentation technique

Recorder Vocast

Le plugin Vocast Recorder permet à un visiteur d’enregistrer un message audio directement depuis une page web, avec une interface légère et personnalisable.

Intégration

Ajoutez ce script dans votre code HTML :

				
					<script src="https://vocast.co/recorder.js?id=XXX"></script>
				
			

Remplacez XXX par l’ID du recorder.

Paramètres additionels

Vous pouvez ajouter les paramètres ci-dessous, provenant de votre site ou base de donnée.

Paramètre Type Description

externalId

string
External ID qui va premettre d’identifier un ID de votre base de donnée

title

string
Variable qui sera défini en titre du vocast

description

string
Variable qui sera défini en description du vocast

images

string
Urls d’images qui seront définis en image de fond du vocast. A séparer par des virgules

Paramètres pour la création d'un Vocasteur

Un Vocasteur est le speaker associé à un vocast.

Un Vocasteur, une fois créé, pourra être associé à d’autres vocasts.

Paramètre Type Description

vocaster_title

string
Nom du Vocasteur (affiché comme auteur du vocast).

vocaster_description

string
Brève description ou biographie du Vocasteur.

vocasteur_image

string
URL de l’image de profil du Vocasteur.

vocasteur_gender

string
Genre du Vocasteur : Male ou Female.

Paramètres pour la création d'un Contributeur

Un Contributeur est le speaker associé à un vocast.

Contrairement à un Vocasteur, un Contributeur est exclusif : il ne peut pas être lié à plusieurs vocasts.

Paramètre Type Description

contributor_title

string
Nom du Contributeur (affiché comme auteur du vocast).

contributor_description

string
Brève description ou biographie du Contributeur.

contributor_image

string
URL de l’image de profil du Contributeur.

contributor_gender

string
Genre du Contributeur : Male ou Female.

Personnalisation du design

Paramètre Type Description

showProfile

boolean
Affiche le nom du compte

background

string
Permet d’afficher en image de fond l’image du profile, un fond de couleur….

showBorder

boolean
Permet d’afficher un bord avec effet ombre

clickToRecord

string
Permet de personnaliser la phrase affichée pour enregistrer le vocast

afterUpload

string
Permet de personnaliser la phrase affichée une fois le vocast enregistré

Personnalisation de la saisie utilisateur

Afin de personnaliser les éléments affichés sur le plugin d’enregistrement du vocast.

Paramètre Type Description

TitleMode

string
enabled, disabled, etc. pour permettre de saisir un titre.

descMode

string
Idem pour la description.

inputContributorPicture

string
Permet à l’utilisateur de charger une photo.

inputAudioFromFile

string
Permet à l’utilisateur de charger un audio.

Personnalisation de la configuration des vocasts

Afin de personnaliser les paramètres des vocasts créés.

Paramètre Type Description

collections

string
Nom de la ou les collections.

status

string
Publié ou brouillon

visibility

string
Public ou privé

Personnalisation des détails de l'audio

Afin de choisir les éléments affichés sur la page lors d’un scan du QR code ou d’un clic sur le lien.

Paramètre Type Description

noTraduction

boolean
Masque l’affichage du drapeau multi-langue

noDetailProfile

boolean
Masque le profil en haut de la page

noStats

boolean
Masque les statistiques de lecture.

noAction

boolean
Supprime les boutons d’action (partage, etc.).

noCollection

boolean
Cache l’affichage des collections du vocast.

downloadable

boolean
Rend l’audio téléchargeable par l’utilisateur.

autoArchive

boolean
Archive automatiquement l’audio après enregistrement.