QT Mp3 Player User Documentation

10
Mp3Factory USER DOCUMENTATION

description

simple mp3 player

Transcript of QT Mp3 Player User Documentation

Page 1: QT Mp3 Player User Documentation

Mp3Factory USER DOCUMENTATION

Page 2: QT Mp3 Player User Documentation

PAGE 1

Module Code: SOFT336SL Module Name: Cross Platform Application Development in C++

Coursework Title: Functional Specification

Deadline Date:2015-12-20 Member of staff responsible for coursework: David Morocco

Programme: BSc (Hons) Software Engineering

Please note that University Academic Regulations are available under Rules and Regulations on the University website www.plymouth.ac.uk/studenthandbook.

Group work: please list all names of all participants formally associated with this work and state whether the work was undertaken alone or as part of a team. Please note you may be required to identify individual responsibility for component parts.

We confirm that we have read and understood the Plymouth University regulations relating to Assessment Offences and that we are aware of the possible penalties for any breach of these regulations. We confirm that this is the independent work of the group. Signed on behalf of the group: Individual assignment: I confirm that I have read and understood the Plymouth University regulations relating to Assessment Offences and that I am aware of the possible penalties for any breach of these regulations. I confirm that this is my own independent work.

Signed:

Use of translation software: failure to declare that translation software or a similar writing aid has been used will be treated as an assessment offence. I *have used/not used translation software. If used, please state name of software…………………………………………………………………

Overall mark _____% Assessors Initials ______ Date_________

Name: H.K.Sadeepa Diluk Jayatissa

Student Reference Number: 10516205

Page 3: QT Mp3 Player User Documentation

PAGE 2

Scope of the project

To create a simple mp3 player with playlist that has functionalities like Play, Pause,

Stop, Next, Preview, Shuffle and mute.

Aim and objective of this project

The aim of this assignment is to produce a suitable design for a software application,

followed by an implementation in C++ using Qt library and a documentation of such

application.

Objective is to design a simple mp3 player with user-friendly GUI and basic and some

advance functionalities of mp3 player.

Functionalities

Program functionalities are followed

Open single or multiple songs and play them.

o This can be done either using the file button in toolbar or just simply

pressing Ctrl+o as the shortcut. And the current status initialized in a

label under volume bar.

Play or pause the song on user preference

o Once the playlist loaded the playlist will be play automatically. User can

pause it by either clicking the play button on the tool bar or clicking the

GUI button placed in bottom of the window or pressing Space button.

And the current status initialized in a label under volume bar.

Stop the song playing

o User can stop it by either clicking the Stop button on the tool bar or

clicking the GUI button placed in bottom of the window or pressing esc

button. And the current status initialized in a label under volume bar.

Play next song

o User can do this by either clicking the next button on the tool bar or

clicking the GUI button placed in bottom of the window or pressing PgUp

button. And the current status initialized in a label under volume bar.

Page 4: QT Mp3 Player User Documentation

PAGE 3

Play previous song

o User can do this by either clicking the previous button on the tool bar or

clicking the GUI button placed in bottom of the window or pressing PgDn

button. And the current status initialized in a label under volume bar.

Shuffle the playlist

o User can pause it by either clicking the shuffle button on the tool bar or

clicking the GUI button placed under the playlist of the window or

pressing Ctrl+Tab button. And the current status initialized in a label

under volume bar.

Mute song

o User can mute it by either clicking the mute button on the tool bar or

clicking the GUI button placed under the playlist of the window or

pressing m button.

Change volume

o Use can change the volume by using the Dial widget placed under playlist

and can see the progress and current volume level on progress bar under

it.

Known Issues and Bugs and reasons for that

Following issues and bugs are discovered while testing

When loading the songs to playlist it shows the full file path instead of file name

o This is because I used QStreingList to store the files paths, but to get the

file name it can be easily done by using QString and

QFileInfo.MetaData(); but it doesn’t support for QStreingList. i have tried

many methods to do that but it won’t work. I have commented those

methods I tried in on_actionOpen_triggered().

When playing the song I tried to display the Album art of the song in the player

if available, or otherwise play an equalizer gif to give more attractiveness to

player, for some reason it’s not working and I couldn’t resolve that

Page 5: QT Mp3 Player User Documentation

PAGE 4

When you clicked shuffle icon it shuffle but can’t restore the playlist

o It’s because of there’s no such method implemented yet in

QMediaPlayer.Shuffle().

When playing the song the title of the song must showing in QLable under the

equalizer image. But it’s not showing. But if you stop the song while playing and

play again it works. There must be some logical error I couldn’t figure out yet.

Page 6: QT Mp3 Player User Documentation

PAGE 5

Supported Platforms

I have tested this application in two different Operating systems and it has been

compiled and run on both platforms without issue

Platforms are Windows 8.1 Pro 64bit and Ubuntu 14.04

WINDOWS 8.1 PRO 64BIT

Page 7: QT Mp3 Player User Documentation

PAGE 6

Page 8: QT Mp3 Player User Documentation

PAGE 7

UBUNTU 14.04

Page 9: QT Mp3 Player User Documentation

PAGE 8

Page 10: QT Mp3 Player User Documentation

PAGE 9