package
0.0.4
Repository: https://github.com/dblk/shottower.git
Documentation: pkg.go.dev

# Functions

AssertAssetRenderResponseRequired checks if the required fields are not zero-ed.
AssertAssetRequired checks if the required fields are not zero-ed.
AssertAssetResponseAttributesRequired checks if the required fields are not zero-ed.
AssertAssetResponseDataRequired checks if the required fields are not zero-ed.
AssertAssetResponseRequired checks if the required fields are not zero-ed.
AssertAudioAssetRequired checks if the required fields are not zero-ed.
AssertClipRequired checks if the required fields are not zero-ed.
AssertCropRequired checks if the required fields are not zero-ed.
AssertEditRequired checks if the required fields are not zero-ed.
AssertFlipTransformationRequired checks if the required fields are not zero-ed.
AssertFontRequired checks if the required fields are not zero-ed.
AssertHTMLAssetRequired checks if the required fields are not zero-ed.
AssertImageAssetRequired checks if the required fields are not zero-ed.
AssertLumaAssetRequired checks if the required fields are not zero-ed.
AssertMergeFieldRequired checks if the required fields are not zero-ed.
AssertMuxDestinationOptionsRequired checks if the required fields are not zero-ed.
AssertMuxDestinationRequired checks if the required fields are not zero-ed.
AssertOffsetRequired checks if the required fields are not zero-ed.
AssertOutputRequired checks if the required fields are not zero-ed.
AssertPosterRequired checks if the required fields are not zero-ed.
AssertProbeResponseRequired checks if the required fields are not zero-ed.
AssertQueuedResponseDataRequired checks if the required fields are not zero-ed.
AssertQueuedResponseRequired checks if the required fields are not zero-ed.
AssertRangeRequired checks if the required fields are not zero-ed.
AssertRecurseAssetRenderResponseRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseAssetResponseAttributesRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseAssetResponseDataRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseAssetResponseRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseAudioAssetRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseClipRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseCropRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseEditRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseFlipTransformationRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseFontRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseHTMLAssetRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseImageAssetRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseInterfaceRequired recursively checks each struct in a slice against the callback.
AssertRecurseLumaAssetRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseMergeFieldRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseMuxDestinationOptionsRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseMuxDestinationRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseOffsetRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseOutputRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecursePosterRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseProbeResponseRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseQueuedResponseDataRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseQueuedResponseRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseRangeRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseRenderResponseDataRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseRenderResponseRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseRotateTransformationRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseShotstackDestinationRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseSizeRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseSkewTransformationRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseSoundtrackRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseSubtitleRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTemplateDataResponseDataRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTemplateDataResponseRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTemplateListResponseDataRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTemplateListResponseItemRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTemplateListResponseRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTemplateRenderRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTemplateRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTemplateResponseDataRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTemplateResponseRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseThumbnailRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTimelineRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTitleAssetRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTrackRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTransformationRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTransitionRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseValueRequired checks each struct in the nested slice against the callback.
AssertRecurseVideoAssetRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRenderResponseDataRequired checks if the required fields are not zero-ed.
AssertRenderResponseRequired checks if the required fields are not zero-ed.
AssertRotateTransformationRequired checks if the required fields are not zero-ed.
AssertShotstackDestinationRequired checks if the required fields are not zero-ed.
AssertSizeRequired checks if the required fields are not zero-ed.
AssertSkewTransformationRequired checks if the required fields are not zero-ed.
AssertSoundtrackRequired checks if the required fields are not zero-ed.
AssertSubtitleRequired checks if the required fields are not zero-ed.
AssertTemplateDataResponseDataRequired checks if the required fields are not zero-ed.
AssertTemplateDataResponseRequired checks if the required fields are not zero-ed.
AssertTemplateListResponseDataRequired checks if the required fields are not zero-ed.
AssertTemplateListResponseItemRequired checks if the required fields are not zero-ed.
AssertTemplateListResponseRequired checks if the required fields are not zero-ed.
AssertTemplateRenderRequired checks if the required fields are not zero-ed.
AssertTemplateRequired checks if the required fields are not zero-ed.
AssertTemplateResponseDataRequired checks if the required fields are not zero-ed.
AssertTemplateResponseRequired checks if the required fields are not zero-ed.
AssertThumbnailRequired checks if the required fields are not zero-ed.
AssertTimelineRequired checks if the required fields are not zero-ed.
AssertTitleAssetRequired checks if the required fields are not zero-ed.
AssertTrackRequired checks if the required fields are not zero-ed.
AssertTransformationRequired checks if the required fields are not zero-ed.
AssertTransitionRequired checks if the required fields are not zero-ed.
AssertVideoAssetRequired checks if the required fields are not zero-ed.
DefaultErrorHandler defines the default logic on how to handle errors from the controller.
EncodeJSONResponse uses the json encoder to write an interface to the http response with an optional status code.
No description provided by the author
IsZeroValue checks if the val is the zero-ed value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewDownloadAPIController creates a default api controller.
NewDownloadAPIService creates a default api service.
NewEditAPIController creates a default api controller.
NewEditAPIService creates a default api service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewRouter creates a new router for any number of api routers.
NewServeAPIController creates a default api controller.
NewServeAPIService creates a default api service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReadFormFilesToTempFiles reads files array data from a request form and writes it to a temporary files.
ReadFormFileToTempFile reads file data from a request form and writes it to a temporary file.
Response return a ImplResponse struct filled.
WithDownloadApiErrorHandler inject ErrorHandler into controller.
WithEditAPIErrorHandler inject ErrorHandler into controller.
WithServeAPIErrorHandler inject ErrorHandler into controller.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
Internal.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ErrTypeAssertionError is thrown when type an interface does not match the asserted type.

# Structs

AssetRenderResponse - The response returned by the Serve API [get asset by render id](#get-asset-by-render-id) request.
AssetResponse - The response returned by the Serve API [get asset](#get-asset) request.
AssetResponseAttributes - The list of asset attributes and their values.
AssetResponseData - The type of resource (an asset) and attributes of the asset.
AudioAsset - The AudioAsset is used to add sound effects and audio at specific intervals on the timeline.
Clip - A clip is a container for a specific type of asset, i.e.
Crop - Crop the sides of an asset by a relative amount.
DownloadAPIController binds http requests to an api service and writes the service results to the http response.
DownloadAPIService is a service that implements the logic for the DownloadAPIServicer This service should implement the business logic for every endpoint for the DownloadApi API.
Edit - An edit defines the arrangement of a video on a timeline, an audio edit or an image design and the output format.
EditAPIController binds http requests to an api service and writes the service results to the http response.
EditAPIService is a service that implements the logic for the EditAPIServicer This service should implement the business logic for every endpoint for the EditApi API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FlipTransformation - Flip a clip vertically or horizontally.
Font - Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag.
HTMLAsset - The HTMLAsset clip type lets you create text based layout and formatting using HTML and CSS.
ImageAsset - The ImageAsset is used to create video from images to compose an image.
ImplResponse response defines an error code with the associated body.
No description provided by the author
No description provided by the author
LumaAsset - The LumaAsset is used to create luma matte masks, transitions and effects between other assets.
MergeField - A merge field consists of a key; `find`, and a value; `replace`.
MuxDestination - Send rendered videos to the [Mux](https://www.mux.com/) video hosting and streaming service.
MuxDestinationOptions - Pass additional options to control how Mux processes video.
Offset - Offsets the position of an asset horizontally or vertically by a relative distance.
Output - The output format, render range and type of media to generate.
ParsingError indicates that an error has occurred when parsing request parameters.
Poster - Generate a poster image for the video at a specific point from the timeline.
ProbeResponse - The response received after a [probe request](#inspect-media) is submitted.
No description provided by the author
QueuedResponse - The response received after a [render request](#render-asset) or [template render](#render-template) is submitted.
QueuedResponseData - The response data returned with the [QueuedResponse](#tocs_queuedresponse).
Range - Specify a time range to render, i.e.
No description provided by the author
RenderResponse - The response received after a [render status request](#get-render-status) is submitted.
RenderResponseData - The response data returned with the [RenderResponse](#tocs_renderresponse) including status and URL.
RequiredError indicates that an error has occurred when parsing request parameters.
RotateTransformation - Rotate a clip by the specified angle in degrees.
A Route defines the parameters for an api endpoint.
ServeAPIController binds http requests to an api service and writes the service results to the http response.
ServeAPIService is a service that implements the logic for the ServeAPIServicer This service should implement the business logic for every endpoint for the ServeApi API.
ShotstackDestination - Send rendered assets to the Shotstack hosting and CDN service.
Size - Set a custom size for a video or image.
SkewTransformation - Skew a clip so its edges are sheared at an angle.
Soundtrack - A music or audio file in mp3 format that plays for the duration of the rendered video or the length of the audio file, which ever is shortest.
Subtitle - Subtitle allow to burn a specific subtitle into the video.
Template - A template is a saved [Edit](#tocs_edit) than can be loaded and re-used.
TemplateDataResponse - The template data including the template name and Edit.
TemplateDataResponseData - The response data returned with the [TemplateDataResponse](#tocs_templatedataresponse).
TemplateListResponse - A list of previously saved templates.
TemplateListResponseData - The response data returned with the [TemplateListResponse](#tocs_templatelistresponse).
TemplateListResponseItem - The individual template item returned with the [TemplateListResponseData](#tocs_templatelistresponsedata) templates list.
TemplateRender - Render a template by it's id and optional merge fields.
TemplateResponse - The response received after a [template](#create-a-template) is submitted.
TemplateResponseData - The response data returned with the [TemplateResponse](#tocs_templateresponse).
Thumbnail - Generate a thumbnail image for the video or image at a specific point from the timeline.
Timeline - A timeline represents the contents of a video edit over time, an audio edit over time, in seconds, or an image layout.
TitleAsset - The TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.
Track - A track contains an array of clips.
Transformation - Apply one or more transformations to a clip.
Transition - In and out transitions for a clip - i.e.
VideoAsset - The VideoAsset is used to create video sequences from video files.

# Interfaces

DownloadApiRouter defines the required methods for binding the api requests to a responses for the DownloadApi The DownloadApiRouter implementation should parse necessary information from the http request, pass the data to a DownloadApiServicer to perform the required actions, then write the service results to the http response.
DownloadApiServicer defines the api actions for the DownloadApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
EditAPIRouter defines the required methods for binding the api requests to a responses for the EditApi The EditAPIRouter implementation should parse necessary information from the http request, pass the data to a EditAPIServicer to perform the required actions, then write the service results to the http response.
EditAPIServicer defines the api actions for the EditApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
No description provided by the author
ProcessingQueuer defines the queue actions while processing new renders.
Router defines the required methods for retrieving api routes.
ServeAPIRouter defines the required methods for binding the api requests to a responses for the ServeApi The ServeAPIRouter implementation should parse necessary information from the http request, pass the data to a ServeAPIServicer to perform the required actions, then write the service results to the http response.
ServeAPIServicer defines the api actions for the ServeApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.

# Type aliases

No description provided by the author
DownloadAPIOption for how the controller is set up.
EditAPIOption for how the controller is set up.
ErrorHandler defines the required method for handling error.
No description provided by the author
Routes are a collection of defined api endpoints.
ServeAPIOption for how the controller is set up.