io.impossible.fx.render

Class FXRenderClient

java.lang.Object

io.impossible.fx.render.FXRenderClient

public class FXRenderClient
extends Object

Constructor Summary

Constructors

Constructor and Description
FXRenderClient(FXRenderAPI api)

Method Summary

Modifier and Type	Method and Description
static FXRenderClientBuilder	builder()
TokenResponse	createRenderToken(TokenRequest request) Create a Token to render a dynamic movie.
String	getPlayURL(String token, String format) Compute a secure render URL for a given token and extension.
String	getPlayURL(String region, String token, String format) Compute a secure render URL for a given token and extension.
String	getRenderURL(String token, String format) Compute a secure render URL for a given token and extension.
String	getRenderURL(String region, String token, String format) Compute a secure render URL for a given token and extension.
TokenResponse	renderToDestination(TokenRequest request, UploadDefinition upload) Render a dynamic movie and upload the rendered video to a remote destination.
InputStream	renderVideo(String token, String format) Render a video for a given token and immediately return the video

Methods inherited from class java.lang.Object

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

Constructor Detail

FXRenderClient

public FXRenderClient(FXRenderAPI api)

Method Detail

builder

public static FXRenderClientBuilder builder()

createRenderToken

public TokenResponse createRenderToken(TokenRequest request)
                                throws FXServiceException

Create a Token to render a dynamic movie.

Parameters:

request - A TokenRequest object with project ID, moviename and render options

Returns:

Throws:

FXServiceException

renderToDestination

public TokenResponse renderToDestination(TokenRequest request,
                                         UploadDefinition upload)
                                  throws FXServiceException

Render a dynamic movie and upload the rendered video to a remote destination.

Returns:

a TokenResponse object with the status and result of the upload.

Throws:

FXServiceException

getRenderURL

public String getRenderURL(String region,
                           String token,
                           String format)

Compute a secure render URL for a given token and extension. This URL points to a video that be used for progressive download and playing

Parameters:

region - Region where movie is published

token - Token obtained from CreateRenderToken

format - Video format, e.g. "mp4", "webm", "jpg", etc.

Returns:

the URL for this rendered video

getRenderURL

public String getRenderURL(String token,
                           String format)

Compute a secure render URL for a given token and extension. This URL points to a video that be used for progressive download and playing

Parameters:

token - Token obtained from CreateRenderToken

format - Video format, e.g. "mp4", "webm", "jpg", etc.

Returns:

the URL for this rendered video

getPlayURL

public String getPlayURL(String region,
                         String token,
                         String format)

Compute a secure render URL for a given token and extension. This URL can be used for streaming.

Parameters:

region - Region where movie is published

token - Token obtained from CreateRenderToken

format - Video format, e.g. "mp4", "webm", "jpg", etc.

Returns:

the URL for this rendered video

getPlayURL

public String getPlayURL(String token,
                         String format)

Compute a secure render URL for a given token and extension. This URL can be used for streaming.

Parameters:

token - Token obtained from CreateRenderToken

format - Video format, e.g. "mp4", "webm", "jpg", etc.

Returns:

the URL for this rendered video

renderVideo

public InputStream renderVideo(String token,
                               String format)
                        throws IOException,
                               FXServiceException

Render a video for a given token and immediately return the video

Parameters:

token - Token obtained from CreateRenderToken

format - Video format, e.g. "mp4", "webm", "jpg", etc.

Returns:

an InputStream to read the content of he video file.

Throws:

IOException

FXServiceException