\Vigas\StreamingPlatforms\ModelStream

Class Stream extends Media.

Manages a stream

Summary

Methods

Properties

Constants

getId()
getGame()
getViewers()
__construct()
getFormatedViewers()
getChannelLanguage()
getChannelName()
getStreamUrl()
getChatUrl()
getPreviewUrl()
getStatus()
getChannelDisplayName()
getSource()

No public properties found

No constants found

No protected methods found

$id
$game
$viewers
$source
$channel_language
$channel_name
$stream_url
$chat_url
$preview_url
$status
$channel_display_name

N/A

No private methods found

No private properties found

N/A

File: StreamingPlatforms\Model\Stream.php
Package: Default
Class hierarchy: \Vigas\StreamingPlatforms\Model\Media

\Vigas\StreamingPlatforms\Model\Stream

Properties

$id

$id : integer

Type

integer — The media id

$game

$game : string

Type

string — The game name

$viewers

$viewers : integer

Type

integer — The number of viewers

$source

$source : string

Type

string — The media's streaming platform

$channel_language

$channel_language : string

Type

string — The channel language

$channel_name

$channel_name : string

Type

string — The channel name

$stream_url

$stream_url : string

Type

string — The stream url

$chat_url

$chat_url : string

Type

string — The chat url

$preview_url

$preview_url : string

Type

string — The stream preview url (thumbnail)

$status

$status : string

Type

string — The stream status (title)

$channel_display_name

$channel_display_name : string

Type

string — The channel display name (streamer name)

Methods

getId()

getId() : integer

Returns

integer —

Returns the media id

getGame()

getGame() : string

Returns

string —

Returns the game name

getViewers()

getViewers() : string

Returns

string —

Returns the number of viewers

__construct()

__construct(integer  $id, string  $game, integer  $viewers, string  $channel_language, string  $channel_name, string  $stream_url, string  $chat_url, string  $preview_url, string  $status, string  $channel_display_name, string  $source)

Parameters

integer	$id	Stream id
string	$game	Game name
integer	$viewers	Number of viewers watching this stream
string	$channel_language	The channel language
string	$channel_name	The channel name
string	$stream_url	The stream url
string	$chat_url	The chat url
string	$preview_url	The stream preview url (thumbnail)
string	$status	The stream status (title)
string	$channel_display_name	The channel display name (streamer name)
string	$source	The stream's streaming platform

getFormatedViewers()

getFormatedViewers() : string

Returns

string —

Returns the formated number of viewers

getChannelLanguage()

getChannelLanguage() : string

Returns

string —

Returns the channel language

getChannelName()

getChannelName() : string

Returns

string —

Returns the channel name

getStreamUrl()

getStreamUrl() : string

Returns

string —

Returns the stream url

getChatUrl()

getChatUrl() : string

Returns

string —

Returns the chat url

getPreviewUrl()

getPreviewUrl() : string

Returns

string —

Returns the stream preview url (thumbnail)

getStatus()

getStatus() : string

Returns

string —

Returns the stream status (title)

getChannelDisplayName()

getChannelDisplayName() : string

Returns

string —

Returns the channel display name (streamer name)

getSource()

getSource() : string

Returns

string —

Returns the stream's streaming platform