IPushPublishHTTPCupertino (Wowza Streaming Engine 4 API)

All Known Implementing Classes:

PushPublishHTTPCupertino, PushPublishHTTPCupertinoAkamaiHandler, PushPublishHTTPCupertinoGoogleHandler
```
public interface IPushPublishHTTPCupertino
```

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`deleteMediaSegment(MediaSegmentModel mediaSegment)` Deletes the media (chunk) at the destination URI.
`String`	`getDestionationLogData()` JSON formatted string containing information unique to the instance.
`boolean`	`isSendToBackupServer()` Is this implementation sending to a backup server
`boolean`	`outputClose()` Close the destination (if needed).
`boolean`	`outputOpen()` Open the destination (if needed) in preparation of having one or more items (playlists/media segments) pushed to it
`int`	`sendGroupMasterPlaylist(String groupName, PlaylistModel playlist)` Sends a group master playlist to the destination.
`int`	`sendMasterPlaylist(PlaylistModel playlist)` Sends the master playlist to the destination.
`int`	`sendMediaPlaylist(PlaylistModel playlist)` Sends the media playlist to the destination.
`int`	`sendMediaSegment(MediaSegmentModel mediaSegment)` Sends the media (chunk) to the destination; media provided as a fragment list.
`void`	`setSendToBackupServer(boolean backup)` Setup to send to a backup destination
`boolean`	`updateGroupMasterPlaylistPlaybackURI(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"
`boolean`	`updateMasterPlaylistPlaybackURI(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 masterPlaylistFilename
`boolean`	`updateMediaPlaylistPlaybackURI(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 mediaPlaylistFilename
`boolean`	`updateMediaSegmentPlaybackURI(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 mediaFilename

- Method Detail
  - deleteMediaSegment
```
int deleteMediaSegment(MediaSegmentModel mediaSegment)
```
    Deletes 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)
  - getDestionationLogData
```
String getDestionationLogData()
```
    JSON formatted string containing information unique to the instance. This information is added to the log entry when starting and stopping the push publish session.
    
    Returns:
    string in JSON format (including outer braces)
  - isSendToBackupServer
```
boolean isSendToBackupServer()
```
    Is this implementation sending to a backup server
    
    Returns:
    true if sending to a backup server
  - outputClose
```
boolean outputClose()
```
    Close 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
  - outputOpen
```
boolean outputOpen()
```
    Open 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
  - sendGroupMasterPlaylist
```
int sendGroupMasterPlaylist(String groupName,
                          PlaylistModel playlist)
```
    Sends a group master playlist to the destination.
    
    Parameters:
    groupName - the group name
    playlist - the group master playlist model
    
    Returns:
    number of bytes sent to output
  - sendMasterPlaylist
```
int sendMasterPlaylist(PlaylistModel playlist)
```
    Sends 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
```
int sendMediaPlaylist(PlaylistModel playlist)
```
    Sends 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)
  - sendMediaSegment
```
int sendMediaSegment(MediaSegmentModel mediaSegment)
```
    Sends 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)
  - setSendToBackupServer
```
void setSendToBackupServer(boolean backup)
```
    Setup to send to a backup destination
  - updateGroupMasterPlaylistPlaybackURI
```
boolean updateGroupMasterPlaylistPlaybackURI(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"
    
    Parameters:
    groupName - group name
    masterPlaylist - master group playlist
    
    Returns:
    true if the uri was updated
  - updateMasterPlaylistPlaybackURI
```
boolean updateMasterPlaylistPlaybackURI(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 masterPlaylistFilename
    
    Parameters:
    playlist - the master playlist model to update the URI in
    
    Returns:
    true if the URI was updated
  - updateMediaPlaylistPlaybackURI
```
boolean updateMediaPlaylistPlaybackURI(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 mediaPlaylistFilename
    
    Parameters:
    playlist - to update the uri in
    
    Returns:
    true if the playlist uri was updated
  - updateMediaSegmentPlaybackURI
```
boolean updateMediaSegmentPlaybackURI(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 mediaFilename
    
    Parameters:
    mediaSegment - to update the uri of
    
    Returns:
    true if the uri was updated

Interface IPushPublishHTTPCupertino

Method Summary

Method Detail

deleteMediaSegment

getDestionationLogData

isSendToBackupServer

outputClose

outputOpen

sendGroupMasterPlaylist

sendMasterPlaylist

sendMediaPlaylist

sendMediaSegment

setSendToBackupServer

updateGroupMasterPlaylistPlaybackURI

updateMasterPlaylistPlaybackURI

updateMediaPlaylistPlaybackURI

updateMediaSegmentPlaybackURI