Package io.antmedia.rest

Class BroadcastRestService

java.lang.Object

io.antmedia.rest.RestServiceBase

io.antmedia.rest.BroadcastRestService

@Component
@Path("/v2/broadcasts")
public class BroadcastRestService
extends RestServiceBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BroadcastRestService.SimpleStat
static class	BroadcastRestService.WebRTCReceiveStats
static class	BroadcastRestService.WebRTCSendStats

Nested classes/interfaces inherited from class io.antmedia.rest.RestServiceBase

RestServiceBase.AppBroadcastStatistics, RestServiceBase.BroadcastStatistics, RestServiceBase.ProcessBuilderFactory

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ABSOLUTE_MOVE
private static final String	CONTINUOUS_MOVE
private static final int	MAX_TOTP_EXPIRATION_TIME
private static final int	MIN_TOTP_EXPIRATION_TIME
private static final String	RELATIVE_MOVE
private static final String	STREAM_ID_NOT_VALID

Fields inherited from class io.antmedia.rest.RestServiceBase

appCtx, appInstance, BUILD_NUMBER, COMMUNITY_EDITION, dataStoreFactory, ENDPOINT_GENERIC, ENTERPRISE_EDITION, ERROR_SOCIAL_ENDPOINT_EXCEPTION_IN_ASKING_AUTHPARAMS, ERROR_SOCIAL_ENDPOINT_UNDEFINED_CLIENT_ID, ERROR_SOCIAL_ENDPOINT_UNDEFINED_ENDPOINT, FETCH_REQUEST_REDIRECTED_TO_ORIGIN, FETCHER_NOT_STARTED_ERROR, HIGH_CPU_ERROR, HTTP, INVALID_STREAM_NAME_ERROR, IPV4_REGEX, logger, LOOPBACK_REGEX, MAX_ITEM_IN_ONE_LIST, RECORD_DISABLE, RECORD_ENABLE, RECORD_NO_SET, REPLACE_CHARS, REPLACE_CHARS_FOR_SECURITY, RTSP, scope, servletContext

Constructor Summary

Constructors

Constructor	Description
BroadcastRestService()

Method Summary

Modifier and Type	Method	Description
Result	addEndpoint(String id, Endpoint endpoint, int resolutionHeight)
Result	addID3Data(String streamId, String data)
Result	addSEIData(String streamId, String data)
Result	addSubscriber(String streamId, Subscriber subscriber)
Result	addSubTrack(String id, String subTrackId)
Result	blockSubscriber(String streamId, String subscriberId, int seconds, String blockType)
jakarta.ws.rs.core.Response	convertHLStoMP4(String hlsFileName, boolean download, boolean deleteHLSFiles)
jakarta.ws.rs.core.Response	createBroadcast(Broadcast broadcast, boolean autoStart)
Result	deleteBroadcast(String id, Boolean deleteSubtracks)
Result	deleteBroadcastsBulk(String streamIds)
void	deleteLocalHLSFiles(File hlsFile)
Result	deleteSubscriber(String streamId, String subscriberId)
Result	enableRecording(String streamId, boolean enableRecording, String recordType, int resolutionHeight)
Result	enableRecording(String streamId, boolean enableRecording, String recordType, int resolutionHeight, String fileName)
jakarta.ws.rs.core.Response	getActiveSubtracks(String id, int offset, int size, String role)
jakarta.ws.rs.core.Response	getActiveSubtracksCount(String id, String role)
BroadcastRestService.SimpleStat	getAppLiveStatistics()
jakarta.ws.rs.core.Response	getBroadcast(String id)
List<Broadcast>	getBroadcastList(int offset, int size, String typeBy, String sortBy, String orderBy, String search)
RestServiceBase.BroadcastStatistics	getBroadcastStatistics(String id)
RestServiceBase.AppBroadcastStatistics	getBroadcastTotalStatistics()
Result	getCameraErrorV2(String streamId)
List<ConnectionEvent>	getConnectionEvents(String streamId, int offset, int size, String subscriberId)
Result	getDuration(String url)
private Endpoint	getEndpointMuxerFromList(String endpointServiceId, Broadcast broadcast)
jakarta.ws.rs.core.Response	getJwtTokenV2(String streamId, long expireDate, String type, String roomId)
String[]	getOnvifDeviceProfiles(String id)
BasicStreamInfo[]	getStreamInfo(String streamId)
jakarta.ws.rs.core.Response	getSubtracks(String id, int offset, int size, String role)
jakarta.ws.rs.core.Response	getTokenV2(String streamId, long expireDate, String type, String roomId)
BroadcastRestService.SimpleStat	getTotalBroadcastNumberV2()
BroadcastRestService.SimpleStat	getTotalBroadcastNumberV2(String search)
Result	getTOTP(String streamId, String subscriberId, String type)
List<WebRTCClientStats>	getWebRTCClientStatsListV2(int offset, int size, String streamId)
BroadcastRestService.WebRTCReceiveStats	getWebRTCLowLevelReceiveStats()
BroadcastRestService.WebRTCSendStats	getWebRTCLowLevelSendStats()
List<Subscriber>	listSubscriberV2(String streamId, int offset, int size)
List<Token>	listTokensV2(String streamId, int offset, int size)
private void	logRtmpEndpointInfo(String id, Endpoint endpoint, boolean result)
Result	moveIPCamera(String id, Float valueX, Float valueY, Float valueZ, String movement)
Result	playNextItem(String id, Integer index)
Result	removeEndpoint(String id, String endpointServiceId, int resolutionHeight)
private Result	removeRTMPEndpointProcess(Broadcast broadcast, Endpoint endpoint, int resolutionHeight, String id)
Result	removeSubTrack(String id, String subTrackId)
Result	revokeSubscribers(String streamId)
Result	revokeTokensV2(String streamId)
String[]	searchOnvifDevicesV2()
Result	sendMessage(String message, String id)
Result	startStreamSourceV2(String id)
Result	stopMove(String id)
Result	stopStreamingV2(String id, Boolean stopSubtracks)
Result	updateBroadcast(String id, BroadcastUpdate broadcast)
Result	updateSeekTime(String id, long seekTimeMs)
void	uploadToS3(boolean deleteHLSFiles, String fileNameWithoutExtension, String outputPath, AppSettings appSettings, StorageClient storageClient)
Result	validateTokenV2(Token token)

Methods inherited from class io.antmedia.rest.RestServiceBase

addEndpoint, addIPCamera, addSource, addStreamSource, addSubTrack, checkStopStreaming, checkStreamUrl, connectToCamera, createBroadcastWithStreamID, deleteBroadcasts, deleteVoD, deleteVoDs, enableRecordMuxing, enableRecordMuxing, getAppContext, getApplication, getAppSettings, getBuildNumber, getCameraErrorById, getDataStore, getDataStoreFactory, getIPArray, getJwtToken, getMp4Muxer, getMuxAdaptor, getProcess, getProcessBuilderFactory, getRoomInfoFromConference, getScope, getServerSettings, getSoftwareVersion, getStreamsDirectory, getToken, getTokenService, getVoD, getWebRTCAdaptor, getWebRTCClientStatsList, importVoDs, isAlreadyRecording, isEnterprise, isInSameNodeInCluster, isMainTrack, isStreaming, logFailedOperation, logWarning, lookupBroadcast, moveAbsolute, moveContinous, moveRelative, processEndpoint, removeRTMPEndpoint, removeSubTrack, replaceCharsForSecurity, revokeTokens, sanitizeAndStripExtension, saveBroadcast, searchOnvifDevices, sendDataChannelMessage, setAppCtx, setApplication, setAppSettings, setDataStore, setDataStoreFactory, setProcessBuilderFactory, setResultSuccess, setScope, setServerSettings, startRecord, startRecord, startStreamSource, startVoDScriptProcess, stopRecord, stopStreaming, unlinksVoD, updatePlayListItemDurationsIfApplicable, updateStreamSource, uploadVoDFile, uploadVoDFile, validateIPaddress, validateStreamURL, validateToken, waitStopStreaming

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

STREAM_ID_NOT_VALID

private static final String STREAM_ID_NOT_VALID

See Also:

• Constant Field Values

RELATIVE_MOVE

private static final String RELATIVE_MOVE

See Also:

• Constant Field Values

ABSOLUTE_MOVE

private static final String ABSOLUTE_MOVE

See Also:

• Constant Field Values

CONTINUOUS_MOVE

private static final String CONTINUOUS_MOVE

See Also:

• Constant Field Values

MIN_TOTP_EXPIRATION_TIME

private static final int MIN_TOTP_EXPIRATION_TIME

See Also:

• Constant Field Values

MAX_TOTP_EXPIRATION_TIME

private static final int MAX_TOTP_EXPIRATION_TIME

See Also:

• Constant Field Values

Constructor Details

BroadcastRestService

public BroadcastRestService()

Method Details

createBroadcast

@POST
@Consumes("application/json")
@Path("/create")
@Produces("application/json")
public jakarta.ws.rs.core.Response createBroadcast(Broadcast broadcast,
 @QueryParam("autoStart")
 boolean autoStart)

deleteBroadcast

@DELETE
@Consumes("application/json")
@Path("/{id}")
@Produces("application/json")
public Result deleteBroadcast(@PathParam("id")
 String id,
 @QueryParam("deleteSubtracks")
 Boolean deleteSubtracks)

Overrides:

deleteBroadcast in class RestServiceBase

deleteBroadcastsBulk

@DELETE
@Consumes("application/json")
@Path("/")
@Produces("application/json")
public Result deleteBroadcastsBulk(@QueryParam("ids")
 String streamIds)

getBroadcast

@GET
@Path("/{id}")
@Produces("application/json")
public jakarta.ws.rs.core.Response getBroadcast(@PathParam("id")
 String id)

getBroadcastList

@GET
@Path("/list/{offset}/{size}")
@Produces("application/json")
public List<Broadcast> getBroadcastList(@PathParam("offset")
 int offset,
 @PathParam("size")
 int size,
 @QueryParam("type_by")
 String typeBy,
 @QueryParam("sort_by")
 String sortBy,
 @QueryParam("order_by")
 String orderBy,
 @QueryParam("search")
 String search)

updateBroadcast

@PUT
@Consumes("application/json")
@Path("/{id}")
@Produces("application/json")
public Result updateBroadcast(@PathParam("id")
 String id,
 BroadcastUpdate broadcast)

Overrides:

updateBroadcast in class RestServiceBase

getDuration

@GET
@Consumes("application/json")
@Path("/duration")
@Produces("application/json")
public Result getDuration(@QueryParam("url")
 String url)

updateSeekTime

@PUT
@Consumes("application/json")
@Path("/{id}/seek-time/{seekTimeMs}")
@Produces("application/json")
public Result updateSeekTime(@PathParam("id")
 String id,
 @PathParam("seekTimeMs")
 long seekTimeMs)

addEndpoint

@POST
@Consumes("application/json")
@Path("/{id}/endpoint")
@Produces("application/json")
public Result addEndpoint(@PathParam("id")
 String id,
 Endpoint endpoint,
 @QueryParam("resolutionHeight")
 int resolutionHeight)

logRtmpEndpointInfo

private void logRtmpEndpointInfo(String id,
 Endpoint endpoint,
 boolean result)

removeEndpoint

@DELETE
@Consumes("application/json")
@Path("/{id}/endpoint")
@Produces("application/json")
public Result removeEndpoint(@PathParam("id")
 String id,
 @QueryParam("endpointServiceId")
 String endpointServiceId,
 @QueryParam("resolutionHeight")
 int resolutionHeight)

removeRTMPEndpointProcess

private Result removeRTMPEndpointProcess(Broadcast broadcast,
 Endpoint endpoint,
 int resolutionHeight,
 String id)

getEndpointMuxerFromList

private Endpoint getEndpointMuxerFromList(String endpointServiceId,
 Broadcast broadcast)

getTotalBroadcastNumberV2

@GET
@Path("/count")
@Produces("application/json")
public BroadcastRestService.SimpleStat getTotalBroadcastNumberV2()

getTotalBroadcastNumberV2

@GET
@Path("/count/{search}")
@Produces("application/json")
public BroadcastRestService.SimpleStat getTotalBroadcastNumberV2(@PathParam("search")
 String search)

getAppLiveStatistics

@GET
@Path("/active-live-stream-count")
@Produces("application/json")
public BroadcastRestService.SimpleStat getAppLiveStatistics()

getTokenV2

@GET
@Path("/{id}/token")
@Produces("application/json")
public jakarta.ws.rs.core.Response getTokenV2(@PathParam("id")
 String streamId,
 @QueryParam("expireDate")
 long expireDate,
 @QueryParam("type")
 String type,
 @QueryParam("roomId")
 String roomId)

getJwtTokenV2

@GET
@Path("/{id}/jwt-token")
@Produces("application/json")
public jakarta.ws.rs.core.Response getJwtTokenV2(@PathParam("id")
 String streamId,
 @QueryParam("expireDate")
 long expireDate,
 @QueryParam("type")
 String type,
 @QueryParam("roomId")
 String roomId)

validateTokenV2

@POST
@Consumes("application/json")
@Path("/validate-token")
@Produces("application/json")
public Result validateTokenV2(Token token)

revokeTokensV2

@DELETE
@Consumes("application/json")
@Path("/{id}/tokens")
@Produces("application/json")
public Result revokeTokensV2(@PathParam("id")
 String streamId)

listTokensV2

@GET
@Path("/{id}/tokens/list/{offset}/{size}")
@Produces("application/json")
public List<Token> listTokensV2(@PathParam("id")
 String streamId,
 @PathParam("offset")
 int offset,
 @PathParam("size")
 int size)

listSubscriberV2

@GET
@Path("/{id}/subscribers/list/{offset}/{size}")
@Produces("application/json")
public List<Subscriber> listSubscriberV2(@PathParam("id")
 String streamId,
 @PathParam("offset")
 int offset,
 @PathParam("size")
 int size)

getConnectionEvents

@GET
@Path("/{id}/connection-events/{offset}/{size}")
@Produces("application/json")
public List<ConnectionEvent> getConnectionEvents(@PathParam("id")
 String streamId,
 @PathParam("offset")
 int offset,
 @PathParam("size")
 int size,
 @QueryParam("subscriberId")
 String subscriberId)

addSubscriber

@POST
@Consumes("application/json")
@Path("/{id}/subscribers")
@Produces("application/json")
public Result addSubscriber(@PathParam("id")
 String streamId,
 Subscriber subscriber)

getTOTP

@GET
@Consumes("application/json")
@Path("/{id}/subscribers/{sid}/totp")
@Produces("application/json")
public Result getTOTP(@PathParam("id")
 String streamId,
 @PathParam("sid")
 String subscriberId,
 @QueryParam("type")
 String type)

deleteSubscriber

@DELETE
@Consumes("application/json")
@Path("/{id}/subscribers/{sid}")
@Produces("application/json")
public Result deleteSubscriber(@PathParam("id")
 String streamId,
 @PathParam("sid")
 String subscriberId)

blockSubscriber

@PUT
@Consumes("application/json")
@Path("/{id}/subscribers/{sid}/block/{seconds}/{type}")
@Produces("application/json")
public Result blockSubscriber(@PathParam("id")
 String streamId,
 @PathParam("sid")
 String subscriberId,
 @PathParam("seconds")
 int seconds,
 @PathParam("type")
 String blockType)

revokeSubscribers

@DELETE
@Consumes("application/json")
@Path("/{id}/subscribers")
@Produces("application/json")
public Result revokeSubscribers(@PathParam("id")
 String streamId)

getBroadcastStatistics

@GET
@Path("/{id}/broadcast-statistics")
@Produces("application/json")
public RestServiceBase.BroadcastStatistics getBroadcastStatistics(@PathParam("id")
 String id)

Overrides:

getBroadcastStatistics in class RestServiceBase

getBroadcastTotalStatistics

@GET
@Path("/total-broadcast-statistics")
@Produces("application/json")
public RestServiceBase.AppBroadcastStatistics getBroadcastTotalStatistics()

Overrides:

getBroadcastTotalStatistics in class RestServiceBase

getWebRTCLowLevelSendStats

@GET
@Path("/webrtc-send-low-level-stats")
@Produces("application/json")
public BroadcastRestService.WebRTCSendStats getWebRTCLowLevelSendStats()

getWebRTCLowLevelReceiveStats

@GET
@Path("/webrtc-receive-low-level-stats")
@Produces("application/json")
public BroadcastRestService.WebRTCReceiveStats getWebRTCLowLevelReceiveStats()

getWebRTCClientStatsListV2

@GET
@Path("/{stream_id}/webrtc-client-stats/{offset}/{size}")
@Produces("application/json")
public List<WebRTCClientStats> getWebRTCClientStatsListV2(@PathParam("offset")
 int offset,
 @PathParam("size")
 int size,
 @PathParam("stream_id")
 String streamId)

enableRecording

@PUT
@Consumes("application/json")
@Path("/{id}/recording/{recording-status}")
@Produces("application/json")
public Result enableRecording(@PathParam("id")
 String streamId,
 @PathParam("recording-status")
 boolean enableRecording,
 @QueryParam("recordType")
 String recordType,
 @QueryParam("resolutionHeight")
 int resolutionHeight,
 @QueryParam("fileName")
 String fileName)

enableRecording

public Result enableRecording(String streamId,
 boolean enableRecording,
 String recordType,
 int resolutionHeight)

getCameraErrorV2

@GET
@Consumes("application/json")
@Path("/{streamId}/ip-camera-error")
@Produces("application/json")
public Result getCameraErrorV2(@PathParam("streamId")
 String streamId)

startStreamSourceV2

@POST
@Consumes("application/json")
@Path("/{id}/start")
@Produces("application/json")
public Result startStreamSourceV2(@PathParam("id")
 String id)

playNextItem

@POST
@Consumes("application/json")
@Path("/playlists/{id}/next")
@Produces("application/json")
public Result playNextItem(@PathParam("id")
 String id,
 @QueryParam("index")
 Integer index)

Overrides:

playNextItem in class RestServiceBase

stopStreamingV2

@POST
@Consumes("application/json")
@Path("/{id}/stop")
@Produces("application/json")
public Result stopStreamingV2(@PathParam("id")
 String id,
 @QueryParam("stopSubtracks")
 Boolean stopSubtracks)

searchOnvifDevicesV2

@GET
@Path("/onvif-devices")
@Produces("application/json")
public String[] searchOnvifDevicesV2()

getOnvifDeviceProfiles

@GET
@Path("/{id}/ip-camera/device-profiles")
@Produces("application/json")
public String[] getOnvifDeviceProfiles(@PathParam("id")
 String id)

Overrides:

getOnvifDeviceProfiles in class RestServiceBase

moveIPCamera

@POST
@Path("/{id}/ip-camera/move")
@Produces("application/json")
public Result moveIPCamera(@PathParam("id")
 String id,
 @QueryParam("valueX")
 Float valueX,
 @QueryParam("valueY")
 Float valueY,
 @QueryParam("valueZ")
 Float valueZ,
 @QueryParam("movement")
 String movement)

stopMove

@POST
@Path("/{id}/ip-camera/stop-move")
@Produces("application/json")
public Result stopMove(@PathParam("id")
 String id)

addSubTrack

@POST
@Consumes("application/json")
@Path("/{id}/subtrack")
@Produces("application/json")
public Result addSubTrack(@PathParam("id")
 String id,
 @QueryParam("id")
 String subTrackId)

removeSubTrack

@DELETE
@Consumes("application/json")
@Path("/{id}/subtrack")
@Produces("application/json")
public Result removeSubTrack(@PathParam("id")
 String id,
 @QueryParam("id")
 String subTrackId)

getSubtracks

@GET
@Consumes("application/json")
@Path("/{id}/subtracks/{offset}/{size}")
@Produces("application/json")
public jakarta.ws.rs.core.Response getSubtracks(@PathParam("id")
 String id,
 @PathParam("offset")
 int offset,
 @PathParam("size")
 int size,
 @QueryParam("role")
 String role)

getActiveSubtracks

@GET
@Consumes("application/json")
@Path("/{id}/active-subtracks/{offset}/{size}")
@Produces("application/json")
public jakarta.ws.rs.core.Response getActiveSubtracks(@PathParam("id")
 String id,
 @PathParam("offset")
 int offset,
 @PathParam("size")
 int size,
 @QueryParam("role")
 String role)

getActiveSubtracksCount

@GET
@Consumes("application/json")
@Path("/{id}/active-subtracks-count")
@Produces("application/json")
public jakarta.ws.rs.core.Response getActiveSubtracksCount(@PathParam("id")
 String id,
 @QueryParam("role")
 String role)

getStreamInfo

@GET
@Consumes("application/json")
@Path("/{id}/stream-info")
@Produces("application/json")
public BasicStreamInfo[] getStreamInfo(@PathParam("id")
 String streamId)

sendMessage

@POST
@Consumes("application/json")
@Path("/{id}/data")
@Produces("application/json")
public Result sendMessage(String message,
 @PathParam("id")
 String id)

addID3Data

@POST
@Consumes("application/json")
@Path("/{stream_id}/id3")
@Produces("application/json")
public Result addID3Data(@PathParam("stream_id")
 String streamId,
 String data)

addSEIData

@POST
@Consumes("application/json")
@Path("/{stream_id}/sei")
@Produces("application/json")
public Result addSEIData(@PathParam("stream_id")
 String streamId,
 String data)

convertHLStoMP4

@POST
@Consumes("application/json")
@Path("/{hls_filename}/hls-to-mp4")
@Produces("application/json")
public jakarta.ws.rs.core.Response convertHLStoMP4(@PathParam("hls_filename")
 String hlsFileName,
 @QueryParam("download")
 boolean download,
 @QueryParam("deleteHLSFiles")
 boolean deleteHLSFiles)

deleteLocalHLSFiles

public void deleteLocalHLSFiles(File hlsFile)

uploadToS3

public void uploadToS3(boolean deleteHLSFiles,
 String fileNameWithoutExtension,
 String outputPath,
 AppSettings appSettings,
 StorageClient storageClient)