Skip to main content
Version: 8.0.3

proofOfPlay

Methods​

recordItemPlayed()​

The recordItemPlayed() method dispatches a sos.command.dispatch() command. It sends provided information about played content along with additional metadata about current applet and device to signageOS.

recordItemPlayed(options: IRecordItemOptions): Promise<void>;

API Example​

import { sos } from '@signageos/front-applet';

void sos.onReady(async () => {
	await sos.proofOfPlay.recordItemPlayed({
		name: 'generic-brand-christmas-coffee-ad',
		customId: 'dBE43bFB3312VFfvd34bgGHJVV334cd2',
		type: 'video',
		tags: ['generic-brand', 'christmas'],
		fileName: 'coffee.mp4',
		playbackSuccess: false,
		errorMessage: 'Unsupported framerate 60fps',
	});
});