Media Actions

Table of contents

  1. App Store
    1. Find App Store Apps
  2. Audio
    1. Record Audio
      1. Qualities
      2. Start Recording
    2. Recognize Music
    3. Get Details of Shazam
      1. Details
  3. Camera
    1. Take Photo
    2. Take Video
      1. Cameras
      2. Qualities
      3. Start Recording
  4. Device
    1. Take Screenshot
    2. Take Interactive Screenshot
      1. Selections
  5. GIFs
    1. Make GIF
    2. Add Frame to GIF
    3. Make Video from GIF
    4. Get Frames from Image
  6. Image Editing
    1. Combine Images
      1. Modes
    2. Crop Image
      1. Positions
    3. Flip Image
      1. Flip Directions
    4. Mask Image
      1. Types
    5. Custom Image Mask
    6. Overlay Image
    7. Custom Image Overlay
      1. Positions
    8. Resize Image
    9. Resize Image By Percentage
    10. Resize Image By Longest Edge
    11. Remove Image Background
    12. Rotate Image or Video
  7. Images
    1. Convert Image
      1. Image Formats
    2. Convert Image to JPEG
    3. Strip Image Metadata
    4. Get Image Detail
      1. Details
    5. Make Image from PDF Page
      1. Colorspaces
    6. Make Image from Rich Text
    7. Extract Text from Image
  8. iTunes Store
    1. Show in iTunes Store
  9. Music
    1. Get Current Song
    2. Add to Music Library
    3. Select Music
    4. Play Music
      1. Shuffles:
      2. Repeats
    5. Get Music Detail
      1. Details
  10. Photos
    1. Create Photo Album
    2. Delete Photos
    3. Get Last Import
    4. Get Latest Bursts
    5. Get Latest Live Photos
    6. Get Latest Screenshots
    7. Get Latest Photos
    8. Get Latest Videos
    9. Remove from Photo Album
    10. Save to Photo Album
    11. Select Photos
  11. Playback
    1. Play Music
    2. Pause Music
    3. Toggle Play/Pause Music
    4. Set Volume
    5. Seek
      1. Durations
      2. Seek Behaviors
    6. Skip Back
    7. Skip Forward
  12. Playing Next
    1. Add to Playing Next
    2. Add to Playing Later
    3. Clear Playing Next
  13. Playlists
    1. Add to Playlist
    2. Create Playlist
    3. Get Songs From Playlist
  14. Podcasts
    1. Find Podcasts
    2. Get Detail of Podcast
      1. Details
    3. Get Podcasts from Library
    4. Play Podcast
  15. Video
    1. Strip Media Metadata
    2. Set Media Metadata
    3. Encode Video
      1. Sizes:
      2. Speeds:
    4. Encode Audio
      1. Formats
    5. Trim Video

App Store

Find App Store Apps

Search the app store for apps using query.

searchAppStore(text query)

Audio

Record Audio

Record some audio.

recordAudio(enum ?quality = "Normal", enum ?start = "On Tap")

Qualities

  • Normal
  • Very High

Start Recording

  • On Tap
  • Immediately

Recognize Music

Use Shazam to recognize music.

startShazam(bool ?show = true, bool ?showError = true)

Get Details of Shazam

Get a detail of a Shazam match.

getShazamDetail(variable input, enum detail)

Details

  • Apple Music ID
  • Artist
  • Title
  • Is Explicit
  • Lyrics Snippet
  • Lyric Snippet Synced
  • Artwork
  • Video URL
  • Shazam URL
  • Apple Music URL
  • Name

Note: Enum values are case-sensitive.

Camera

Take Photo

Takes number of photo(s).

takePhoto(integer ?count = 1, boolean ?showPreview = true)

Take Video

Takes a video using camera in quality.

takeVideo(enum ?camera = "Front", enum ?quality = "High", enum ?recordingStart = "Immediately")

Cameras

  • Front
  • Back

Qualities

  • Low
  • Medium
  • High

Start Recording

  • On Tap
  • Immediately

Note: Enum values are case-sensitive.

Device

Take Screenshot 

takeScreenshot(bool ?mainMonitorOnly = false)

Note: mainMonitorOnly will only apply to a Mac

Take Interactive Screenshot

Take an interactive Screenshot

takeInteractiveScreenshot(enum ?selection = "Window")

Selections

  • Window
  • Custom

Note: Enum values are case-sensitive.

Note: Mac-only action

GIFs

Make GIF

Create a GIF.

makeGIF(variable input, text ?delay = "0.3", number ?loops, text ?width, text ?height)

Add Frame to GIF

Add a frame to a GIF.

addToGIF(text image, text gif, text ?delay = "0.25", bool ?autoSize = true, text ?width, text ?height)

Note: width and height can only be used when autoSize is false.

Make Video from GIF

Make video from gif, looping loops number of times. Returns GIF as video.

makeVideoFromGIF(variable gif, number ?loops = 1)

Get Frames from Image

Get frames from an image.

getImageFrames(variable image)

Image Editing

Combine Images

Combine images using mode with spacing.

combineImages(variable images, text ?mode = "vertically", number ?spacing = 1)

Modes

  • Horizontally
  • Vertically
  • Grid

Crop Image

Crop image at position to width and height. Returns cropped image.

cropImage(variable image, text ?width = "100", text ?height = "100", enum ?position = "Center", text ?customPositionX, text ?customPositionY)

Positions

  • Center
  • Top Left
  • Top Right
  • Bottom Left
  • Bottom Right
  • Custom

Note: Enum values are case-sensitive.

Flip Image

Flip image in direction. Returns the flipped image.

flipImage(variable image, enum direction)

Flip Directions

  • Horizontal
  • Vertical

Note: Enum values are case-sensitive.

Mask Image

Mask an image. The radius only applies to the Rounded Rectangle type.

maskImage(variable image, enum type, text ?radius)

Types

  • Rounded Rectangle
  • Ellipse
  • Icon

Note: Enum values are case-sensitive.

Custom Image Mask

Put a custom mask on an image.

customImageMask(variable image, variable customMaskImage)

Overlay Image

Shows an image editor to the user to overlay an image onto another image.

overlayImage(variable image, variable overlayImage)

Custom Image Overlay

Overlay an image onto another image.

customImageOverlay(variable image, variable overlayImage, text ?width, text ?height, text ?rotation = "0", text ?opacity = "100", enum ?position = "Center", text ?customPositionX, text ?customPositionY)

Positions

  • Center
  • Top Left
  • Top Right
  • Bottom Left
  • Bottom Right
  • Custom

Note: Enum values are case-sensitive.

Resize Image

Resize an image.

resizeImage(variable image, text width, text ?height)

Resize Image By Percentage

Resize an image by a percentage.

resizeImageByPercent(variable image, text percentage)

Resize Image By Longest Edge

Resize an image by the longest edge.

resizeImageByLongestEdge(variable image, text length)

Remove Image Background

Remove the background from an image.

removeBackground(variable image, boolean ?crop = false)

Rotate Image or Video

Rotate an image or video by degrees. Returns rotated image.

rotateMedia(variable image, text degrees)

Images

Convert Image

Convert an image to another image format.

convertImage(variable image, enum format, float ?quality, bool ?preserveMetadata = true)

Image Formats

  • TIFF
  • GIF
  • PNG
  • BMP
  • PDF
  • HEIF

Convert Image to JPEG

Convert an image to a JPEG.

convertToJPEG(variable image, number ?compressionQuality, bool ?preserveMetadata = true)

Strip Image Metadata

Strip metadata from an image.

stripImageMetadata(variable image)

Get Image Detail

Get detail from an image.

getImageDetail(variable image, enum detail)

Details

  • Album
  • Width
  • Height
  • Date Taken
  • Media Type
  • Photo Type
  • Is a Screenshot
  • Is a Screen Recording
  • Location
  • Duration
  • Frame Rate
  • Orientation
  • Camera Make
  • Camera Model
  • Metadata Dictionary
  • Is Favorite
  • File Size
  • File Extension
  • Creation Date
  • File Path
  • Last Modified Date
  • Name

Make Image from PDF Page

Make an image from a PDF page.

makeImageFromPDFPage(variable pdf, enum ?colorSpace = "RGB", text ?pageResolution = "300")

Colorspaces

  • RGB
  • Gray

Make Image from Rich Text

Make an image from rich text.

makeImageFromRichText(variable pdf, text width, text height)

Extract Text from Image

Extract text from an image.

extractImageText(variable image)

iTunes Store

Show in iTunes Store

Show product in the iTunes Store.

showIniTunes(product)

Music

Get Current Song

Gets the current song.

getCurrentSong()

Add to Music Library

Add songs to music library.

addToMusic(songs)

Select Music

Select song(s) from the Music app.

selectMusic(bool ?selectMultiple = false)

Play Music

Play music.

playMusic( music, enum ?shuffle, enum ?repeat)

Shuffles:

  • Off
  • Songs

Repeats

  • None
  • One
  • All

Note: Enum values are case-sensitive.

Get Music Detail 

getMusicDetail(variable music, enum detail)

Details

  • Title
  • Album
  • Artist
  • Album Artist
  • Genre
  • Composer
  • Date Added
  • Media Kind
  • Duration
  • Play Count
  • Track Number
  • Disc Number
  • Album Artwork
  • Is Explicit
  • Lyrics
  • Release Date
  • Comments
  • Is Cloud Item
  • Skip Count
  • Last Played Date
  • Rating
  • File Path
  • Name

Note: Enum values are case-sensitive.

Photos

Create Photo Album

Create an album named name with photos.

createAlbum(text name, variable ?images)

Delete Photos

Delete photos from photo library.

deletePhotos(variable photos)

Get Last Import

Gets the latest photo import.

getLastImport()

Get Latest Bursts

Get latest photo bursts.

getLatestBursts(number count)

Get Latest Live Photos

Get latest live photos.

getLatestLivePhotos(number count)

Get Latest Screenshots

Get latest screenshots.

getLatestScreenshots(number count)

Get Latest Photos

Get latest photos.

getLatestPhotos(number count, bool ?includeScreenshots = true)

Get Latest Videos

Get latest videos.

getlatestVideos(number count)

Remove from Photo Album

Remove photo to photo album album.

removeFromAlbum(variable photo, text album)

Save to Photo Album

Save photo to photo album album.

savePhoto(variable photo, text ?album = "Recents")

Select Photos

Select photos from photo library.

selectPhotos(bool ?selectMultiple = false)

Playback

Play Music

Play Apple Music on current device.

play()

Pause Music

Pause Apple Music on current device.

pause()

Toggle Play/Pause Music

Play/Pause Apple Music on current device depending on the current play status.

togglePlayPause()

Set Volume

Set device volume to number.

setVolume(number number)

Seek

Seek currently playing.

seek(number magnitude, enum duration, enum ?behavior = "To Time")

Durations

  • hr
  • min
  • sec

Seek Behaviors

  • To Time
  • Forward By
  • Backward By

Note: Enum values are case-sensitive.

Skip Back

Skip back to the previous song.

skipBack()

Skip Forward

Skip forward to the next song.

skipFwd()

Playing Next

Add to Playing Next

Add music as the next to play in the queue.

playNext(variable music)

Add to Playing Later

Add music as the last to play in the queue.

playLater(variable music)

Clear Playing Next

Clears the songs up next.

clearUpNext()

Playlists

Add to Playlist

Add songs to playlist with name.

addToPlaylist(text playlistName, variable songs)

Create Playlist

Create a playlist.

createPlaylist(text title, variable ?songs, text ?description, text ?author)

Get Songs From Playlist

Get songs in a playlist.

getPlaylistSongs(variable playlistName)

Podcasts

Find Podcasts

Search Apple Podcasts for podcasts using query.

searchPodcasts(text query)

Get Detail of Podcast 

getPodcastDetail(variable podcast, enum detail)

Details

  • Feed URL
  • Genre
  • Episode Count
  • Artist
  • Store ID
  • Store URL
  • Artwork
  • Artwork URL
  • Name

Note: Enum values are case-sensitive.

Get Podcasts from Library

Get the user’s podcasts from their library.

getPodcasts()

Play Podcast

Play a podcast.

playPodcast(variable podcast)

Video

Strip Media Metadata

Strip metadata from video or video.

stripMediaMetadata(variable media)

Set Media Metadata

Set metadata for a video or audio.

setMetadata(variable media, variable ?artwork, text ?title, text ?artist, text ?album, text ?genre, text ?year)

Encode Video

Encode a video.

encodeVideo(variable video, enum ?size = "Passthrough", enum ?speed = "Normal", boolean ?preserveTransparency = false)

Sizes:

  • 640×480
  • 960×540
  • 1280×720
  • 1920×1080
  • 3840×2160
  • HEVC 1920×1080
  • HEVC 3840x2160
  • ProRes 422

Speeds:

  • 0.5X
  • Normal
  • 2X

Encode Audio

Encode audio.

encodeAudio(variable audio, enum ?format = "M4A", enum ?speed = "Normal")

Formats

  • M4A
  • AIFF

Trim Video

Prompts the user to trim video. Returns the trimmed video.

trimVideo(variable video)