Class

WKInterfaceMovie

An interface element that lets you play video and audio content in your watchOS app.

Declaration

class WKInterfaceMovie : WKInterfaceObject

Overview

A movie object displays a poster image with a play button on top of it. When the user taps the play button, WatchKit plays the movie in a modal interface.

Do not subclass or create instances of this class yourself. Instead, define outlets in your interface controller class and connect them to the corresponding objects in your storyboard file. For example, to refer to a movie object in your interface, define a property with the following syntax in your interface controller class:

@IBOutlet weak var myMovie: WKInterfaceMovie!

During the initialization of your interface controller, WatchKit creates any needed movie objects and assigns them to their associated outlets. At that point, you can use those objects to make changes to the onscreen content.

Do not attempt to play audio or video content while gathering heart rate data using Health Kit. If you use this class to play media, WatchKit automatically disables the gathering of heart rate data.

Supported Media Formats

Table 1 lists the encoding information to use when creating media files to play on a user’s Apple Watch. For audio and video assets played directly from your app, keep your clips relatively short. Short clips consume less space on disk, use less power, and take less time to download.

Table 1

Media encoding

Media type

Recommended encoding

Video assets

Video codec: H.264 High Profile

Bit rate: 160 kpbs at up to 30 fps

Full screen resolution: 208 x 260 in portrait orientation

16:9 resolution: 320 x 180 in landscape orientation

Audio bit rate: 32 kpbs stereo

Audio-only assets

Bit rate: 32 kbps stereo

Interface Builder Configuration Options

Xcode lets you configure information about your movie interface object in your storyboard file. Table 2 lists the attributes you can configure and their meaning.

Table 2

WatchKit movie attributes

Attribute

Description

Video Gravity

The sizing behavior for the movie. Use this attribute to determine whether the movie maintains its aspect ratio and how it fills the available space. You can also configure this value programmatically using the setVideoGravity(_:) method.

Poster Image

The placeholder image to display for your movie. When the user taps the poser image, the movie interface object presents a modal sheet with the actual movie contents. You can also configure this value programmatically using the setPosterImage(_:) method.

Topics

Setting the Movie Attributes

func setMovieURL(URL)

Sets the URL of the movie to play.

func setVideoGravity(WKVideoGravity)

Sets the resizing behavior for the movie content.

func setPosterImage(WKImage?)

Sets the poster image to display for the movie.

func setLoops(Bool)

Sets a Boolean value indicating whether the movie plays in a continuous loop.

Relationships

Inherits From

Conforms To

See Also

Images and Movies

class WKInterfaceImage

An image that can be displayed in the interface of your watchOS app.

class WKImage

A wrapper for images you use with a picker interface.

protocol WKImageAnimatable

A collection of methods you can use to control the playback of animated images.

class WKInterfaceInlineMovie

An interface element that displays a video's poster image and supports inline playing of the video.

class WKInterfaceHMCamera

An interface element that displays either a video stream or a single snapshot from an IP camera connected to HomeKit.

enum WKVideoGravity

Constants indicating the appearance of video content.