com.zego.zegoliveroom.callback

Interface IZegoStreamRecordCallback

public interface IZegoStreamRecordCallback

Recording event callback interface.

Method Summary

Modifier and Type	Method and Description
void	onMixStreamRecordUpdate(java.lang.String[] listStreamID) Reports changes to the input streams in a mixed recording.
void	onRecordFilePath(java.lang.String streamID, java.lang.String filePath, int muxerStreamType, long startTimestamp, long stopTimestamp) Reports a recording file path.
void	onRecordStreamStatus(java.lang.String streamID, int muxerStatus, int muxerType) Reports recording stream status.
void	onSeek(java.lang.String streamID, long offset, int whence) Reports a seek request for the recording output.
void	onStreamRecordBegin(java.lang.String streamID, java.lang.String pathAndName) Reports that recording has started.
void	onStreamRecordData(java.lang.String streamID, byte[] data) Delivers recording data.
void	onStreamRecordEnd(java.lang.String streamID, java.lang.String pathAndName, int reason) Reports that recording has ended.
void	onStreamRecordEvent(java.lang.String streamID, int event) Reports events during recording.
void	onStreamRecordRemoteMicOperation(java.lang.String streamID, int operation, int reason) Reports changes to the remote microphone state.
void	onStreamRecordVideoSizeChanged(java.lang.String streamID, int width, int height) Reports the video resolution.
void	onVideoMixStateChanged(java.lang.String streamID, int state) Changes in whether an input stream contributes video to a mixed recording.

Method Detail

onStreamRecordBegin

void onStreamRecordBegin(java.lang.String streamID,
                         java.lang.String pathAndName)

Reports that recording has started.

Parameters:

streamID - Stream ID. An empty string indicates a mixed recording.

pathAndName - Path of the recording file.

onStreamRecordEnd

void onStreamRecordEnd(java.lang.String streamID,
                       java.lang.String pathAndName,
                       int reason)

Reports that recording has ended.

Parameters:

streamID - Stream ID. An empty string indicates a mixed recording.

pathAndName - Path of the recording file.

reason - Reason recording ended. See ZegoRecordEndReason.

onStreamRecordVideoSizeChanged

void onStreamRecordVideoSizeChanged(java.lang.String streamID,
                                    int width,
                                    int height)

Reports the video resolution.

Parameters:

streamID - Stream ID.

width - Video width.

height - Video height.

This callback is also triggered when the video resolution changes.

onStreamRecordRemoteMicOperation

void onStreamRecordRemoteMicOperation(java.lang.String streamID,
                                      int operation,
                                      int reason)

Reports changes to the remote microphone state.

Parameters:

streamID - Stream ID.

operation - Microphone state: -1 = unknown, 0 = on, 1 = off.

reason - Reason for the state change.

onStreamRecordEvent

void onStreamRecordEvent(java.lang.String streamID,
                         int event)

Reports events during recording.

Parameters:

streamID - Stream ID. An empty string indicates a mixed recording.

event - Recording event. See ZegoRecordEvent.

onStreamRecordData

void onStreamRecordData(java.lang.String streamID,
                        byte[] data)

Delivers recording data.

Parameters:

streamID - Stream ID. An empty string indicates a mixed recording.

data - Recording data.

This callback is triggered only when ZegoLiveRoom.setMuxerOutType(int) is set to ZegoMuxerOutType.CALLBACK_ONLY.

onSeek

void onSeek(java.lang.String streamID,
            long offset,
            int whence)

Reports a seek request for the recording output.

Parameters:

streamID - Stream ID. An empty string indicates a mixed recording.

offset - Seek offset.

whence - Reference position for the offset: SEEK_SET, SEEK_CUR, or SEEK_END.

This callback is triggered only when ZegoLiveRoom.setMuxerOutType(int) is set to ZegoMuxerOutType.CALLBACK_ONLY. Seek to the requested position before writing subsequent data from onStreamRecordData(java.lang.String, byte[]).

onMixStreamRecordUpdate

void onMixStreamRecordUpdate(java.lang.String[] listStreamID)

Reports changes to the input streams in a mixed recording.

Parameters:

listStreamID - IDs of streams currently included in the recording.

Only streams from which data has been received successfully are listed. The SDK retries failed streams and triggers this callback when their playback states change.

onRecordFilePath

void onRecordFilePath(java.lang.String streamID,
                      java.lang.String filePath,
                      int muxerStreamType,
                      long startTimestamp,
                      long stopTimestamp)

Reports a recording file path.

Parameters:

streamID - Stream ID. An empty string indicates a mixed recording.

filePath - Path of the recording file.

muxerStreamType - Recorded media type. See ZegoMuxerStreamType.

startTimestamp - Recording start time of the segment, in milliseconds.

stopTimestamp - Recording end time of the segment, in milliseconds.

This callback is triggered when recording audio and video in separate files or using the M3U8 format.

startTimestamp and stopTimestamp apply only to M3U8 recordings.

onRecordStreamStatus

void onRecordStreamStatus(java.lang.String streamID,
                          int muxerStatus,
                          int muxerType)

Reports recording stream status.

Parameters:

streamID - Stream ID. An empty string indicates a mixed recording file.

muxerStatus - Recording stream status.

muxerType - Recorded media type.

Configure "muxer_max_wait_stream_sec" before recording to enable this callback.

For example, with "muxer_max_wait_stream_sec=10", a recording configured for audio and video triggers this callback after 10 seconds if only audio is available.

onVideoMixStateChanged

void onVideoMixStateChanged(java.lang.String streamID,
                            int state)

Changes in whether an input stream contributes video to a mixed recording.

Parameters:

streamID - ID of an input stream in the mixed recording.

state - Video content update state: 0 means video is available; 1 means no video is available.