Class PushPublishHTTPCupertinoGenericHandler
Object
com.wowza.wms.pushpublish.model.PushPublishBase
com.wowza.wms.pushpublish.model.PushPublishHTTPBase
com.wowza.wms.pushpublish.protocol.cupertino.PushPublishHTTPCupertino
com.wowza.wms.pushpublish.protocol.cupertino.PushPublishHTTPCupertinoGenericHandler
- All Implemented Interfaces:
IPushPublish,IPushPublishHTTPGroupMember,IPushPublishHTTPOutputBuilder,IPushPublishHTTPCupertino
Pushes HLS to any HTTP server that accepts PUT (and optionally DELETE) requests, with no CDN specific
naming, authentication or path conventions.
ingest paths look like http(s)://{host}:{port}/[{basePath}/][{groupName}/]{dstStreamName}/(playlist|chunklist).m3u8
http(s)://{host}:{port}/[{basePath}/][{groupName}/]{dstStreamName}/{segmentName}
group ingest paths http(s)://{host}:{port}/[{basePath}/]{groupName}/playlist.m3u8
playback paths are the same by default, but the host, scheme and base can be overridden with "playbackHost"
and "http.playbackBaseUrl" for servers that ingest and serve on different endpoints.
-
Field Summary
Fields inherited from class com.wowza.wms.pushpublish.protocol.cupertino.PushPublishHTTPCupertino
addEndListOnDisconnect, chunkDurationTarget, CHUNKLISTNAME_AUDIOONLY, CHUNKLISTNAME_AUDIOVIDEO, CHUNKLISTNAME_KEYFRAMEONLY, CHUNKLISTNAME_VIDEOONLY, CHUNKLISTNAMES, cupertinoTemplateStringReplacer, keepMediaSegmentDataAfterSending, liveStreamPacketizerCupertino, minNumToDelete, minNumToSend, PLAYLISTNAME, pusher, RENDITION_AUDIOONLY, RENDITION_AUDIOVIDEO, RENDITION_KEYFRAMEONLY, RENDITION_SUBTITLES, RENDITION_VIDEOONLY, RENDITIONINDEX_AUDIOONLY, RENDITIONINDEX_AUDIOVIDEO, RENDITIONINDEX_COUNT, RENDITIONINDEX_KEYFRAMEONLY, RENDITIONINDEX_SUBTITLES, RENDITIONINDEX_VIDEOONLY, SUBTITLELISTNAME, TAG_TYPE_MEDIA, TAG_TYPE_STREAM_INFFields inherited from class com.wowza.wms.pushpublish.model.PushPublishHTTPBase
CACHE_CONTROL_FACTOR, CACHE_CONTROL_HEADER, CACHE_CONTROL_HEADER_KEY, CACHE_CONTROL_HEADER_NONE, CACHE_CONTROL_MEDIA_DEFAULT, httpLogManifests, httpManifestDebug, INDETERMINATE_PLAYLIST_COUNT, maxSegmentCountFromMap, maxSegmentCountFromPacketizer, MIN_PLAYLIST_COUNT, playlistAcrossSessions, playlistBaseUrl, playlistCountFromMap, playlistCountFromPacketizer, playlistCrossName, playlistDurationFromMap, playlistMap, playlistName, playlistTimeout, relativePlaylistsFields inherited from class com.wowza.wms.pushpublish.model.PushPublishBase
appInstance, className, DESTINATION_BAK, DESTINATION_PRI, DESTINATION_RED, destinationName, destinationServer, dstStreamName, entryName, hostname, inetAddr, isAdaptiveStreaming, isExternalRedundancy, logger, mImplementation, myMap, password, playbackHostname, port, portConfigured, profile, properties, pushPublishSession, pushPublishStreamDebug, pushPublishType, reconnectWaitTime, sendingPerformance, sendToBackupServer, srcStream, srcStreamName, totalIOPerformance2Last, totalIOPerformanceLast, userNameFields inherited from interface com.wowza.wms.pushpublish.model.IPushPublish
CONNECTED_STATE_CONNECTED, CONNECTED_STATE_CONNECTING, CONNECTED_STATE_NOT_CONNECTED, CONNECTED_STATE_WAITING, PUSHPUBLISH_MAP_PATH_FIELD_NAME, PUSHPUBLISH_TYPE_CUPERTINO, PUSHPUBLISH_TYPE_MPEGDASH, PUSHPUBLISH_TYPE_NOTIFY_PACKET, PUSHPUBLISH_TYPE_RTMP, PUSHPUBLISH_TYPE_RTP, PUSHPUBLISH_TYPE_RTP_BUFFERED, PUSHPUBLISH_TYPE_SANJOSE, PUSHPUBLISH_TYPE_SRT, PUSHPUBLISH_TYPE_UNKNOWN, PUSHPUBLISH_TYPE_WEBRTC_WHIPFields inherited from interface com.wowza.wms.pushpublish.model.IPushPublishHTTPOutputBuilder
PUSHER_ERROR_LIVEPACKETIZER_NOT_CONFIGURED, PUSHER_ERROR_RENDITIONS_MISCONFIGURED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidconnect()createByteWriter(URI uri) intdeleteMediaSegment(MediaSegmentModel mediaSegment) Deletes the media (chunk) at the destination URI.booleanprotected Stringprotected intprotected StringThe destination stream name.Get a JSON formatted string of data that represents the destination to include with the connect/disconnect logginggetGroupDestinationURL(String groupName) protected StringThe path of this target's stream folder, relative to the base path.voidinit(IApplicationInstance appInstance, String streamName, IMediaStream stream, Map<String, String> profileData, Map<String, String> maps, com.wowza.wms.pushpublish.manager.IPushPublisher pushPublisher, boolean streamDebug) Inits the instance.voidLoads map and profile parametersbooleanClose the destination (if needed).booleanOpen the destination (if needed) in preparation of having one or more items (playlists/media segments) pushed to itvoidintsendGroupMasterPlaylist(String groupName, PlaylistModel playlist) Sends a group master playlist to the destination.intsendMasterPlaylist(PlaylistModel playlist) Sends the master playlist to the destination.intsendMediaPlaylist(PlaylistModel playlist) Sends the media playlist to the destination.intsendMediaSegment(MediaSegmentModel mediaSegment) Sends the media (chunk) to the destination; media provided as a fragment list.booleanupdateGroupMasterPlaylistPlaybackURI(String groupName, PlaylistModel masterPlaylist) Get the group master playlist URI for the given group master playlist file that a player would use to consume the content from the CDN Example: "http://myHost.com/myPath/myGroup/playlist.m3u8"booleanupdateMasterPlaylistPlaybackURI(PlaylistModel playlist) update the master playlist URI for the provided playlist model that a player would use to consume the content from the CDN Example: "http://myHost.com/myPath/myStream/playlist.m3u8" where "playlist.m3u8" is the value given for masterPlaylistFilenamebooleanupdateMediaPlaylistPlaybackURI(PlaylistModel playlist) update/set the media playlist (chunklist) URI for the provided media playlist file that a player would use to consume the content from the CDN Example: "http://myHost.com/myPath/myStream/chunklist.m3u8" where "chunklist.m3u8" is the value given for mediaPlaylistFilenamebooleanupdateMediaSegmentPlaybackURI(MediaSegmentModel mediaSegment) set the media URI for the given media (chunk) file that a player would use to consume the content from the CDN Example: "http://myHost.com/myPath/myStream/media_1.ts" where "media_1.ts" is the value given for mediaFilenameMethods inherited from class com.wowza.wms.pushpublish.protocol.cupertino.PushPublishHTTPCupertino
adaptiveGroupPlaylistNeedsUpdating, addAudioMediaTag, addPlaylistToMasterPlaylist, addTagToPlaylist, addTagToPlaylist, createGroupPlaylist, createMasterPlaylist, createMediaPlaylist, createMediaSegmentModel, createOutputItem, createStreamInfTag, createTag, determinePlaylistSubstitutes, disconnect, disconnect, error, getAudioAutoselect, getAudioCodecId, getAudioDefault, getAudioName, getAudioTagTypesStr, getChunkDurationTarget, getConnectedState, getContextStr, getGroupIdAudioString, getGroupPlaylistRenditionDescription, getHeaderSegment, getLanguageId, getLastChunkId, getLiveStreamPacketizerCupertino, getLiveStreamPacketizerName, getMediaPlaylistForRendtion, getMediaPlaylistPlaybackURL, getMediaPlaylists, getMediaPlaylistStr, getMessagesAttemptedCount, getMessagesFailedCount, getMessagesRetriedCount, getPacketizerLock, getPlaylistCount, getPlaylistReader, getRandomSessionStr, getRenditionsStr, isGroupReady, isInRedundancyPair, isRendition, loadMediaSegment, outputSend, prepareMediaPlaylist, printPlaylist, processPlaylistChunks, renditionIndexToRendition, renditionToPacketizerRendition, renditionToRenditionIndex, resetNewPacketizer, sendGroupPlaylist, setAudioAutoselect, setAudioCodecId, setAudioDefault, setAudioName, setAudioTagTypesStr, setLanguageId, setLiveStreamPacketizer, setPlaylistGroupidAudio, setRenditionsStr, writeTagToStringMethods inherited from class com.wowza.wms.pushpublish.model.PushPublishHTTPBase
getAdaptiveGroupName, getMaxSegmentCount, getPlaylistBaseUrl, getPlaylistMap, getPlaylistTimeout, isInAdaptiveGroup, isLogDebugManifest, isPlaylistAcrossSessions, isRelativePlaylists, logDebugManifest, setAdaptiveGroupName, setMaxSegmentCountFromMap, setMaxSegmentCountFromPacketizer, setPlaylistAcrossSessions, setPlaylistBaseUrl, setPlaylistCountFromMap, setPlaylistCountFromPacketizer, setPlaylistTimeout, setRelativePlaylistsMethods inherited from class com.wowza.wms.pushpublish.model.PushPublishBase
add, addIOPerformance2, clearLoggingValues, createPushPublishSession, getAppInstance, getBandwidth, getBaseParams, getDestinationID, getDestinationName, getDestinationServer, getDstStreamName, getEntryName, getHostname, getImplementation, getInetAddr, getMap, getMessagesOutBytes, getMessagesOutCount, getPassword, getPlaybackHostname, getPort, getProfile, getProperties, getPushPublishType, getReconnectWaitTime, getSrcStream, getSrcStreamName, getUserName, getWowzaStreamingEngineVersionStr, incrementMessagesOut, isAdaptiveStreaming, isDebugLog, isExternalRedundancy, isPortConfigured, isSendToBackupServer, logDebug, logError, logError, logError, logInfo, logWarn, resolveHostName, setAdaptiveStreaming, setAdaptiveStreaming, setAppInstance, setDebugLog, setDestinationName, setDestinationServer, setDestinationServer, setDstStreamName, setEntryName, setExternalRedundancy, setExternalRedundancy, setHost, setHostname, setImplementation, setInetAddr, setPassword, setPlaybackHostname, setPort, setPort, setProfile, setReconnectWaitTime, setSendToBackupServer, setSrcStream, setSrcStreamName, setStreamName, setUserName, updateLoggingValues, updateUsageTrackerMethods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.wowza.wms.pushpublish.model.IPushPublish
getFailureReason, isFailureRecoverableMethods inherited from interface com.wowza.wms.pushpublish.protocol.cupertino.IPushPublishHTTPCupertino
isSendToBackupServer, setSendToBackupServerMethods inherited from interface com.wowza.wms.pushpublish.model.IPushPublishHTTPGroupMember
getAdaptiveGroupName, isInAdaptiveGroup, isLogDebugManifest, isSendToBackupServer, supportsBackupDestinationMethods inherited from interface com.wowza.wms.pushpublish.model.IPushPublishHTTPOutputBuilder
getAppInstance, getDstStreamName, getSrcStreamName, isDebugLog
-
Constructor Details
-
PushPublishHTTPCupertinoGenericHandler
public PushPublishHTTPCupertinoGenericHandler() throws com.wowza.wms.server.LicensingException- Throws:
com.wowza.wms.server.LicensingException
-
-
Method Details
-
init
public void init(IApplicationInstance appInstance, String streamName, IMediaStream stream, Map<String, String> profileData, Map<String, String> maps, com.wowza.wms.pushpublish.manager.IPushPublisher pushPublisher, boolean streamDebug) Description copied from class:PushPublishHTTPBaseInits the instance.- Specified by:
initin interfaceIPushPublish- Overrides:
initin classPushPublishHTTPCupertino- Parameters:
appInstance- the app instancestreamName- the source stream nameprofileData- the profile paramsmaps- the map entry paramsstreamDebug- stream debug flag
-
load
Description copied from class:PushPublishHTTPBaseLoads map and profile parameters- Overrides:
loadin classPushPublishHTTPCupertino- Parameters:
dataMap- the data map
-
connect
public void connect()- Specified by:
connectin interfaceIPushPublish- Overrides:
connectin classPushPublishHTTPCupertino
-
resetConnection
public void resetConnection()- Specified by:
resetConnectionin interfaceIPushPublish- Overrides:
resetConnectionin classPushPublishHTTPCupertino
-
getDestinationStreamName
The destination stream name. The backup side of a redundant pair takes a "-b" suffix so it does not overwrite its primary's output at the destination -- the same separation the cloud-storage handlers use. The adaptive group folder is deliberately not suffixed, so both sides of a pair publish one group master playlist that references each side's own stream folder.- Returns:
- the destination stream name
-
getStreamPath
The path of this target's stream folder, relative to the base path. Streams that belong to an adaptive group live in a folder named after the group so the group master playlist can reference them relatively.- Returns:
- the stream path
-
getDestinationPort
protected int getDestinationPort() -
getDestinationDomain
-
getDestinationURL
- Returns:
- the URL of this target's stream folder on the destination server
-
getGroupDestinationURL
- Parameters:
groupName- the adaptive group name- Returns:
- the URL of the group folder on the destination server
-
getPlaybackBaseURL
- Returns:
- the base URL a player uses to fetch the pushed content. This is the ingest URL unless the destination serves content from somewhere else.
-
getPlaybackURL
- Returns:
- the URL a player would use to start playback of this target, either the group master playlist if the target is in an adaptive group, or this target's own master playlist if not
-
updateMasterPlaylistPlaybackURI
Description copied from interface:IPushPublishHTTPCupertinoupdate the master playlist URI for the provided playlist model that a player would use to consume the content from the CDN Example: "http://myHost.com/myPath/myStream/playlist.m3u8" where "playlist.m3u8" is the value given for masterPlaylistFilename- Parameters:
playlist- the master playlist model to update the URI in- Returns:
- true if the URI was updated
-
updateMediaPlaylistPlaybackURI
Description copied from interface:IPushPublishHTTPCupertinoupdate/set the media playlist (chunklist) URI for the provided media playlist file that a player would use to consume the content from the CDN Example: "http://myHost.com/myPath/myStream/chunklist.m3u8" where "chunklist.m3u8" is the value given for mediaPlaylistFilename- Parameters:
playlist- to update the uri in- Returns:
- true if the playlist uri was updated
-
updateMediaSegmentPlaybackURI
Description copied from interface:IPushPublishHTTPCupertinoset the media URI for the given media (chunk) file that a player would use to consume the content from the CDN Example: "http://myHost.com/myPath/myStream/media_1.ts" where "media_1.ts" is the value given for mediaFilename- Parameters:
mediaSegment- to update the uri of- Returns:
- true if the uri was updated
-
updateGroupMasterPlaylistPlaybackURI
Description copied from interface:IPushPublishHTTPCupertinoGet the group master playlist URI for the given group master playlist file that a player would use to consume the content from the CDN Example: "http://myHost.com/myPath/myGroup/playlist.m3u8"- Parameters:
groupName- group namemasterPlaylist- master group playlist- Returns:
- true if the uri was updated
-
sendMasterPlaylist
Description copied from interface:IPushPublishHTTPCupertinoSends the master playlist to the destination.- Parameters:
playlist- the master playlist model- Returns:
- number of bytes sent to output (less than zero implies the implementation does not support, 0 is a failure, > 0 is success)
-
sendMediaPlaylist
Description copied from interface:IPushPublishHTTPCupertinoSends the media playlist to the destination.- Parameters:
playlist- the media playlist model- Returns:
- number of bytes sent to output (less than zero implies the implementation does not support, 0 is a failure, > 0 is success)
-
sendGroupMasterPlaylist
Description copied from interface:IPushPublishHTTPCupertinoSends a group master playlist to the destination.- Parameters:
groupName- the group nameplaylist- the group master playlist model- Returns:
- number of bytes sent to output
-
sendMediaSegment
Description copied from interface:IPushPublishHTTPCupertinoSends the media (chunk) to the destination; media provided as a fragment list.- Parameters:
mediaSegment- the media file in fragment list form- Returns:
- number of bytes sent to output (less than zero implies the implementation does not support, 0 is a failure, > 0 is success)
-
deleteMediaSegment
Description copied from interface:IPushPublishHTTPCupertinoDeletes the media (chunk) at the destination URI. Default implementation assumes the URI uses the HTTP schema and deletes the media using the WSE HTTPByteWriter. Implementations not using the HTTP schema or not wanting to use the default HTTPByteWriter should override the default method.- Parameters:
mediaSegment- the media destination URI- Returns:
- number of bytes sent if successful (less than zero implies the implementation does not support, 0 is a failure, > 0 is success)
-
outputOpen
public boolean outputOpen()Description copied from interface:IPushPublishHTTPCupertinoOpen the destination (if needed) in preparation of having one or more items (playlists/media segments) pushed to it- Returns:
- true if the destination was opened
-
outputClose
public boolean outputClose()Description copied from interface:IPushPublishHTTPCupertinoClose the destination (if needed). All items (playlist/media segments) have been pushed to bring the destination up to date with the current state- Returns:
- true if the destination was closed
-
createByteWriter
-
destroyByteWriter
public boolean destroyByteWriter() -
getPlaylistProperties
- Specified by:
getPlaylistPropertiesin interfaceIPushPublishHTTPGroupMember- Overrides:
getPlaylistPropertiesin classPushPublishHTTPCupertino
-
getDestionationLogData
Description copied from class:PushPublishHTTPCupertinoGet a JSON formatted string of data that represents the destination to include with the connect/disconnect logging- Specified by:
getDestionationLogDatain interfaceIPushPublishHTTPCupertino- Specified by:
getDestionationLogDatain classPushPublishHTTPCupertino- Returns:
- JSON formatted string representation
-