ttv::chat::IChatReplay Class Reference

#include <ichatreplay.h>

Inheritance diagram for ttv::chat::IChatReplay:

Public Member Functions
virtual	~IChatReplay ()
virtual TTV_ErrorCode	Dispose ()=0
virtual TTV_ErrorCode	Play ()=0
virtual TTV_ErrorCode	Pause ()=0
virtual TTV_ErrorCode	Seek (Timestamp timestamp)=0
virtual TTV_ErrorCode	NudgePlayhead (uint64_t timestampMilliseconds)=0
virtual TTV_ErrorCode	GetCurrentTime (Timestamp &timestamp) const =0
virtual TTV_ErrorCode	DeleteMessage (const std::string &messageId)=0
virtual TTV_ErrorCode	GetChannelId (UserId &result) const =0
virtual TTV_ErrorCode	GetReplayState (ChatReplayState &result) const =0

Detailed Description

The interface for chat replay functionality.

Constructor & Destructor Documentation

~IChatReplay()

virtual ttv::chat::IChatReplay::~IChatReplay ( )

virtual

Member Function Documentation

DeleteMessage()

virtual TTV_ErrorCode ttv::chat::IChatReplay::DeleteMessage ( const std::string &  messageId )

pure virtual

Deletes the given message from the replay on the backend so that it cannot be viewed by any other users. The user's OAuth token must have permission to perform the deletion.

Implemented in ttv::chat::ChatReplay.

Dispose()

virtual TTV_ErrorCode ttv::chat::IChatReplay::Dispose ( )

pure virtual

This should be called when the application is done with the instance.

Implemented in ttv::chat::ChatReplay.

GetChannelId()

virtual TTV_ErrorCode ttv::chat::IChatReplay::GetChannelId ( UserId &  result ) const

pure virtual

Puts the channel ID in result.

Implemented in ttv::chat::ChatReplay.

GetCurrentTime()

virtual TTV_ErrorCode ttv::chat::IChatReplay::GetCurrentTime ( Timestamp &  timestamp ) const

pure virtual

Retrieves the time for the playhead.

Implemented in ttv::chat::ChatReplay.

GetReplayState()

virtual TTV_ErrorCode ttv::chat::IChatReplay::GetReplayState ( ChatReplayState &  result ) const

pure virtual

Puts the current replay state in result. Set to PAUSED initially.

Implemented in ttv::chat::ChatReplay.

NudgePlayhead()

virtual TTV_ErrorCode ttv::chat::IChatReplay::NudgePlayhead ( uint64_t  timestampMilliseconds )

pure virtual

Moves the playhead to absolute time in milliseconds, should be called periodically by the player to correct millisecond clock drift.

Implemented in ttv::chat::ChatReplay.

Pause()

virtual TTV_ErrorCode ttv::chat::IChatReplay::Pause ( )

pure virtual

Pauses the playhead. Should be called when the video player's pause is called, or when the video player starts buffering.

Implemented in ttv::chat::ChatReplay.

Play()

virtual TTV_ErrorCode ttv::chat::IChatReplay::Play ( )

pure virtual

Initiates playback of the messages and causes the playhead to advance. Should be called when the video player starts playing, or resumes from buffering, with a NudgePlayhead() if necessary. Has no effect when current ChatReplayState is BUFFERING, because playback will automatically resume when done buffering.

Implemented in ttv::chat::ChatReplay.

Seek()

virtual TTV_ErrorCode ttv::chat::IChatReplay::Seek ( Timestamp  timestamp )

pure virtual

Sets the current playhead time to be the given time. If the state is playing this may cause buffering if the messages around the given time are not locally cached.

Implemented in ttv::chat::ChatReplay.

---

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

• modules/chat/chat_common/include/twitchsdk/chat/ichatreplay.h