Skip to main content
Version: 6.3.0

Proof of Play

All methods

MethodsDescriptionSupported since
recordItemPlayed()Log that content was played successfully5.5.1

recordItemPlayed()

Send provided information about played content along with additional metadata about current applet and device to SignageOS.

Parameters

ParamTypeRequiredDescription
optionsObject
Yes
Object containing information about played content

Options

Here is the options object defined as Typescript interface:

interface IRecordItemOptions {
name: string;
customId?: string;
type?: 'video' | 'image' | 'html' | 'custom';
tags?: string[];
fileName?: string;
playbackSuccess?: boolean;
errorMessage?: string;
}

Javascript example


await sos.proofOfPlay.recordItemPlayed({
name: 'tesla-commercial-ad-christmas-campaign',
customId: 'dBE43bFB3312VFfvd34bgGHJVV334cd2',
type: 'video',
tags: ['tesla', 'christmas'],
fileName: 'tesla.mp4',
playbackSuccess: false,
errorMessage: 'Unsupported framerate 60fps',
});