You.i Engine
CYIAbstractVideoPlayer::NetworkTimeoutInterface Class Referenceabstract

Detailed Description

Interface containing functionality related to customizing timeout behaviour for network requests made by the player.

Player implementations which support network timeouts implement this interface and return a pointer to the instance via CYIAbstractVideoPlayer::GetNetworkTimeoutInterface.

The timeouts available are connection and request timeouts.

Note
Timeouts must be set before media is prepared to take effect for a media session.

#include <player/YiAbstractVideoPlayer.h>

Public Member Functions

virtual ~NetworkTimeoutInterface ()=default
 
virtual void SetConnectionTimeout (std::chrono::milliseconds timeout)=0
 
virtual std::chrono::milliseconds GetConnectionTimeout () const =0
 
virtual void SetRequestTimeout (std::chrono::milliseconds timeout)=0
 
virtual std::chrono::milliseconds GetRequestTimeout () const =0
 

Constructor & Destructor Documentation

◆ ~NetworkTimeoutInterface()

virtual CYIAbstractVideoPlayer::NetworkTimeoutInterface::~NetworkTimeoutInterface ( )
virtualdefault

Member Function Documentation

◆ GetConnectionTimeout()

virtual std::chrono::milliseconds CYIAbstractVideoPlayer::NetworkTimeoutInterface::GetConnectionTimeout ( ) const
pure virtual

Returns the connection timeout value.

See also
SetConnectionTimeout

◆ GetRequestTimeout()

virtual std::chrono::milliseconds CYIAbstractVideoPlayer::NetworkTimeoutInterface::GetRequestTimeout ( ) const
pure virtual

Returns the request timeout value.

See also
SetRequestTimeout

◆ SetConnectionTimeout()

virtual void CYIAbstractVideoPlayer::NetworkTimeoutInterface::SetConnectionTimeout ( std::chrono::milliseconds  timeout)
pure virtual

Set the connection timeout value used by the player. Connection time respresents the time between attempting to connect to the server and the time connection is achieved.

◆ SetRequestTimeout()

virtual void CYIAbstractVideoPlayer::NetworkTimeoutInterface::SetRequestTimeout ( std::chrono::milliseconds  timeout)
pure virtual

Set the request timeout value used by the player. Request time represents the time, after a connection is established, between starting a network request and the time first chunk of data is received.


The documentation for this class was generated from the following file: