io.impossible.fx.templates

Class FXTemplateClient

java.lang.Object

io.impossible.fx.templates.FXTemplateClient

public class FXTemplateClient
extends Object

Constructor Summary

Constructors

Constructor and Description
FXTemplateClient(FXTemplateAPI api)

Method Summary

Modifier and Type	Method and Description
static FXTemplateClientBuilder	builder()
String	createTemplate(String prjuid, String name, byte[] input) Create a Template from a Movie Definition encoded as a FXProto.Movie ProtoBuffer message.
boolean	deleteTemplate(String prjuid, String name) Delete a Movie Template from a project
JetSDL.Proto.FXProto.Movie	getMovieDefinition(String prjuid, String name)
InputStream	getRawMovieDefinitionInputStream(String prjuid, String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

FXTemplateClient

public FXTemplateClient(FXTemplateAPI api)

Method Detail

builder

public static FXTemplateClientBuilder builder()

getRawMovieDefinitionInputStream

public InputStream getRawMovieDefinitionInputStream(String prjuid,
                                                    String name)
                                             throws FXServiceException,
                                                    FXClientException

Throws:

FXServiceException

FXClientException

getMovieDefinition

public JetSDL.Proto.FXProto.Movie getMovieDefinition(String prjuid,
                                                     String name)
                                              throws FXServiceException,
                                                     FXClientException

Throws:

FXServiceException

FXClientException

createTemplate

public String createTemplate(String prjuid,
                             String name,
                             byte[] input)
                      throws FXServiceException

Create a Template from a Movie Definition encoded as a FXProto.Movie ProtoBuffer message. To convert a ProtoBuffer Movie message to a byte[], call movie.toByteArray().

Parameters:

prjuid - UID of project to place this movie in

name - Name for this template

input - encoded Movie Template

Returns:

Throws:

FXServiceException

deleteTemplate

public boolean deleteTemplate(String prjuid,
                              String name)
                       throws FXServiceException

Delete a Movie Template from a project

Parameters:

prjuid - ID of project

name - Name of template to delete

Returns:

true if delete operation was successful.

Throws:

FXServiceException