ttv::broadcast::IIngestTester Class Reference

#include <iingesttester.h>

Inheritance diagram for ttv::broadcast::IIngestTester:

Public Types
enum	TestState {   TestState::Stopped, TestState::Connecting, TestState::Testing, TestState::Disconnecting,   TestState::Finished, TestState::Failed }

Public Member Functions
virtual	~IIngestTester ()
virtual TTV_ErrorCode	GetTestState (TestState &result) const =0
virtual TTV_ErrorCode	GetIngestServer (IngestServer &result) const =0
virtual TTV_ErrorCode	Start (const IngestServer &ingestServer)=0
virtual TTV_ErrorCode	Cancel ()=0
virtual TTV_ErrorCode	GetMeasuredKbps (uint32_t &result)=0
virtual TTV_ErrorCode	GetTestError (TTV_ErrorCode &result)=0
virtual TTV_ErrorCode	SetTestDurationMilliseconds (uint64_t duration)=0
virtual TTV_ErrorCode	GetTestDurationMilliseconds (uint64_t &result) const =0
virtual TTV_ErrorCode	GetProgress (float &result) const =0
virtual TTV_ErrorCode	GetUserId (UserId &result) const =0

Detailed Description

The interface for the ingest testing service. This will test a single ingest server.

Member Enumeration Documentation

TestState

enum ttv::broadcast::IIngestTester::TestState

strong

Enumerator
Stopped
Connecting
Testing
Disconnecting
Finished
Failed

Constructor & Destructor Documentation

~IIngestTester()

virtual ttv::broadcast::IIngestTester::~IIngestTester ( )

virtual

Member Function Documentation

Cancel()

virtual TTV_ErrorCode ttv::broadcast::IIngestTester::Cancel ( )

pure virtual

Stop testing the current server and abort the rest of the test. This will cause the test to fail with error TTV_EC_REQUEST_ABORTED.

Implemented in ttv::broadcast::IngestTester.

GetIngestServer()

virtual TTV_ErrorCode ttv::broadcast::IIngestTester::GetIngestServer ( IngestServer &  result ) const

pure virtual

Returns the ingest server currently being tested. If there is no server then TTV_EC_INVALID_STATE will be returned.

Implemented in ttv::broadcast::IngestTester.

GetMeasuredKbps()

virtual TTV_ErrorCode ttv::broadcast::IIngestTester::GetMeasuredKbps ( uint32_t &  result )

pure virtual

Retrieves the computed kilobits (1000 bits) per second of the connection to the ingest server.

Implemented in ttv::broadcast::IngestTester.

GetProgress()

virtual TTV_ErrorCode ttv::broadcast::IIngestTester::GetProgress ( float &  result ) const

pure virtual

The overall progress between [0,1].

Implemented in ttv::broadcast::IngestTester.

GetTestDurationMilliseconds()

virtual TTV_ErrorCode ttv::broadcast::IIngestTester::GetTestDurationMilliseconds ( uint64_t &  result ) const

pure virtual

Gets the number of milliseconds in which to test each server.

Implemented in ttv::broadcast::IngestTester.

GetTestError()

virtual TTV_ErrorCode ttv::broadcast::IIngestTester::GetTestError ( TTV_ErrorCode &  result )

pure virtual

Retrives the error associated with the test, if available.

Implemented in ttv::broadcast::IngestTester.

GetTestState()

virtual TTV_ErrorCode ttv::broadcast::IIngestTester::GetTestState ( TestState &  result ) const

pure virtual

Retrieves the current state of the test.

Implemented in ttv::broadcast::IngestTester.

GetUserId()

virtual TTV_ErrorCode ttv::broadcast::IIngestTester::GetUserId ( UserId &  result ) const

pure virtual

The owning user id.

Implemented in ttv::broadcast::IngestTester.

SetTestDurationMilliseconds()

virtual TTV_ErrorCode ttv::broadcast::IIngestTester::SetTestDurationMilliseconds ( uint64_t  duration )

pure virtual

Sets the number of milliseconds in which to test each server.

Implemented in ttv::broadcast::IngestTester.

Start()

virtual TTV_ErrorCode ttv::broadcast::IIngestTester::Start ( const IngestServer &  ingestServer )

pure virtual

Start the testing the given server.

Implemented in ttv::broadcast::IngestTester.

---

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

• modules/broadcast/broadcast_common/include/twitchsdk/broadcast/iingesttester.h