Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.58 KB

animate.md

File metadata and controls

54 lines (36 loc) · 2.58 KB
Raw

GIPHY Animated Text Creation

Dynamic Text Feature

This new service creates animated text results for search queries where there are no matching results in GIPHY's library. These results are returned in a number of different animation styles giving your users a variety of options to best express themselves.

Requirements

  • GIPHY SDK v2.0.5 (or above)
  • To access this feature, you'll need to create a new SDK Key
  • This feature isn't as 'plug-and-play' as the other features of the SDK. Some additional setup and logic is required to properly offer it in your app.

Enabling Dynamic Text in the GPHSettings

Ensure that the .text GPHContentType is included in your GPHSettings.mediaTypeConfig array.

settings.mediaTypeConfig = arrayOf(GPHContentType.gif, GPHContentType.sticker, GPHContentType.text)

Enable the GIPHY Text creation experience by setting the GPHSettings.enableDynamicText flag to true:

settings.enableDynamicText = true

New Media property: isDynamic

The isDynamic property of Media signifies animated text assets that are dynamically generated based on user input and are not indexed in the GIPHY Library.

As a result, the id property of dynamic media does not represent a normal GIPHY id. Properties and operations such as gifByID will not work properly for them.

For media that isDynamic, it is necessary to send or store the asset url, rather than just the media id. It is not possible to fetch the image assets from the id.

if (media.isDynamic) {  // handle accordingly }

GPHContent.animate (for use with GiphyGridView)

This feature is exposed as an additional GPHContent (.animate) analogous to the existing .searchQuery and .trending

val trending = GPHContent.trending(mediaType: MediaType, ratingType: RatingType = RatingType.pg13)
val search = GPHContent.searchQuery("hello")

// new: 
val animatedText = GPHContent.animate("hey what up! hope this all makes sense.")

When populating the GiphyGridView with dynamic text, provide a visual indicator to clarify to the user that they are in a creation context as opposed to a search context.

Renditions

We will only return GIF & WebP files for dynamic text. These are renditions available at launch: original, fixed_width, fixed_width_downsampled, fixed_width_small, preview_gif, preview_webp.