Audio Player

From KickApps Documentation

The audio player can play files in the following formats:

• .mp3
• .flv

The audio player can be a bit tricky to understand at first because its visual representation is hidden by default in the Advanced Audio Player template. To find it, click on "Audio Player Component 1" in the Layers panel.

Though the audio player can be used without any controls by having its Play on load setting enabled, it is typically operated by a scrubber, volume control, and buttons programmed (via Events and Actions) to play, pause, and change to the previous and next audio tracks in the audio player's feed or playlist.

Contents 1 Properties 2 Content 3 Background & Border 4 Layout 4.1 Layout Constraints 5 Events 5.1 Standard Events 5.2 Audio Player Events 6 Actions 6.1 Standard Actions 6.2 Audio Player Actions

Properties

Properties are configurable aspects of a component that let you customize the way it looks and how it works by changing their values in its configuration panel in the App Studio. You can also use JavaScript to change widget properties after the widget loads on a page using the setComponentProperty() method method of the Widget JavaScript API. Finally, you can use widget property values in Actions using our bracket literal syntax. For a listing of all properties on KickApps components, see our Properties Reference.

Scrubber

Select a Scrubber component from the dropdown. If the dropdown is empty, add a Scrubber to your widget by dragging a Scrubber component from the Components panel on the left.

Volume Control

Select a Volume Control component from the dropdown. If the dropdown is empty, add a Volume Control to your widget by dragging a Volume Control component from the Components panel on the left.

Playback Options

Play on load

Start playing the first track when the player loads.

Auto-play

When one track ends, play the next track in the feed/playlist.

Auto-advance

When a track ends, advance to the next track in the feed/playlist.

Content

• Feed
  • Pick a previously saved feed from the dropdown, or enter the URL to an mRSS feed, .mp3, or .flv file.
• Playlist
  • Select audio tracks from your KickApps library to compose a playlist

Background & Border

Background Colors

Choose two different colors to create a gradient or, for a solid color, choose the same color in both options.

Background Opacities

Set the opacity of the top and bottom halves of the audio component. Accepts integer values from 0 (transparent) to 100 (opaque).

Highlight Opacities

Create a highlight effect by altering the opacity of the first and second quarters of the component.

Icon Color

Choose the color for the audio component's icon.

Border Color

Choose the color of the audio component's border.

Border Thickness

Set the thickness of the audio component's border.

Layout

There are two types of containers: the widget canvas itself (background of the entire widget) is considered a container, and you can also create containers that enclose components within your widget. Like any standard component, containers that you create can be moved around the stage, resized, and styled. The most powerful feature of Containers, though, is their ability to fix the positions of their constituent components via layout constraints, which we'll cover below. To create a container, select multiple components, right-click, and select "Group in new container".

You can configure a container's background color, opacity, border color, border thickness, corner radius, and background image in its Properties panel:

You can also mask content in a container by selecting the Mask Content checkbox at the bottom of the panel above. With masking enabled, components that belong to the container but fall outside its bounds will be hidden. To indicate this, when you're editing a container that has masking enabled in Design mode, and then add a component outside the bounds of the container you're in, that component will be translucent:

Masking is useful for situations in which you want to animate a component into a container after it loads initially.

Layout Constraints

Layout constraints let you anchor components a certain distance away from the sides and axes of their containers. Components with layout constraints enabled maintain their offset distances when their containers are resized. To set layout constraints, double click on your container, then single click on a component within it. The Layout Constraints panel will appear:

The checkboxes along the top side of the square in the Layout Constraints panel can be used to anchor the selected component to the left, vertical center, and right sides of its container. The checkboxes along the left side of the square can be used to anchor the selected component to the top, horizontal center, and bottom sides of its container.

When you select a checkbox, a text input field appears across the box from it. The number in this field represents the offset distance, in pixels, from the selected side of the container. For example, this is what it looks like when you anchor to the left side:

If you then resize this container, the component maintains its distance from the left side:

Similarly, you can anchor a component to the top of its container, and it will maintain its distance from the top when its container is resized:

You can also anchor components to the horizontal and vertical center lines of their containers. This component is anchored to the horizontal center of its container. It maintains its distance from the horizontal center when its container is resized.

This component is anchored to the vertical center of its container. It maintains its distance from the vertical center when its container is resized.

Components anchored to opposite sides of their containers expand and contract to maintain their offsets. Below is a component anchored to both the left and right sides of its container. Note how it expands to maintain its distances from the left and right sides.

The component below is anchored to both the top and bottom sides of its container. It contracts when its container is resized.

Events

Standard Events

• Click
• Component hidden
• Component loaded
• Component shown
• Double click
• Mouse down
• Mouse up
• Roll out
• Roll over

Audio Player Events

• Media Paused
• Media Playing
• Media Start
• Media End
• Media Percent Complete
  • Specify the percentage of playback at which this event should be fired
• Media Time Elapsed
  • Specify how many seconds of playback should occur before firing the event (whole seconds only; no decimals)
• Media Change

Actions

Standard Actions

• Drag/Stop Drag
• Set depth
• Show/Hide
• Tween Blur
• Tween Color
• Tween Drop Shadow
• Tween Glow
• Tween Property
• Update Property
  • For a listing of all properties on KickApps components, see our Properties Reference.

Audio Player Actions

• Play/Pause
• Set Media URL
• Change Selection
• Mute |