import OlapicStreamEntity from 'OlapicDevKit-ES6/src/core/entities/stream/stream.entity.js'

public class | source

OlapicStreamEntity

OlapicEntity → OlapicStreamEntity

This represents the Olapic streams in DevKit.

Constructor Summary

Public Constructor
public	constructor(data: Object) The class constructor that receives the stream information.

Public Members
public	alias: String An alias/name for the entity.
public get	handler: OlapicStreamsHandler: * A shortcut method to get access to the streams handler object.

Public Methods
public	getBaseImage(): Promise<OlapicMediaEntity, Error> Gets the stream base image as a media entity.
public	getCoverImage(): Promise<OlapicMediaEntity, Error> Gets the stream cover image as a media entity.

From class OlapicEntity
public get	handler: OlapicEntitiesHandler: * A quick shortcut for the entities so they can access their own entities handler.
public	alias: String An alias/name for the entity, for debug purposes.
public	data: Object The entity information.
public	get(path: string): * Access the entity data using a path-like format.
public	toString(): string A utility method that returns the entity name/alias.

The class constructor that receives the stream information.

Name	Type	Attribute	Description
data	Object		All the information for the stream.

An alias/name for the entity.

A shortcut method to get access to the streams handler object.

the handler object for this specific type of entity.

Gets the stream base image as a media entity.

A promise with the media entity or an Error object if something goes wrong.

.getBaseImage().then((media) => {
    console.log(media.get('caption'));
});

Gets the stream cover image as a media entity.

A promise with the media entity or an Error object if something goes wrong.

.getCoverImage().then((media) => {
    console.log(media.get('caption'));
});