Ticket #19 (closed enhancement: fixed)

Opened 3 years ago

Last modified 2 years ago

0016773: [Transcoding] Transcoding Profile restcall

Reported by: admin Owned by: MC-arjen
Priority: minor Milestone: MediaMosa 1.7
Component: REST Version: 1.7.1
Keywords: Cc:
MoSCoW: Estimated time after impact analysis:
Related to project: none Tested:
Accepted: yes Estimated Hours:

Description

Like to see a REST interface to maintain transcoding profiles which includes an option to see a list of all the defined profiles with their parameters and an option to create/update/delete (own) transcoding profiles.


http://mantis.kennisnet.nl/view.php?id=16773
0016773: [Transcoding] Profielen restcall

We missen een restcall voor het beheer van Transcoding profielen

- opvragen overzicht transcoding profielen (is er al) maar dan aangevuld met een lijst van alle instellingen
- mogelijkheid om eigen profielen maken en te beheren

Attachments

VPX Transcoding management.odt (18.3 kB) - added by erik 2 years ago.
Proposal

Change History

Changed 3 years ago by Frans

  • priority changed from major to minor
  • component set to REST
  • milestone changed from MediaMosa X.X to MediaMosa 1.7

Changed 2 years ago by erik

Proposal

Changed 2 years ago by robert

  • status changed from new to closed
  • resolution set to ready_for_review
  • related_to set to none

Changed 2 years ago by robert

  • status changed from closed to reopened
  • resolution ready_for_review deleted

Changed 2 years ago by robert

  • status changed from reopened to closed
  • resolution set to fixed

Changed 2 years ago by Frans

  • version set to 1.7.0

Changed 2 years ago by Michiel.Schok

Difficult to test.

Tried using the attached .odt, but that is absolutely outdated. Missing parameters, not working examples etc.

Can somebody with more insight into the system tell me what
"
Ega's can create and maintain their own transcode profiles with a
number of new restcalls.
"
exactly means?

I searched documentation on mediamosa.org/api but those docs are not finished.


See for instance the page about transcode/profile (http://mediamosa.org/node/3653) under the 1.6.4 or 1.5.7. section. That contains text about the 1.7.0 version.
The example output given, is NOT from the 1.7.0 call /transcode/profile, but instead the output of /transcode/profiles (mind the 's') on 1.6.4/1.5.7.
1.7.0 gives some extra's, that are not documented. What's the meaning of those?


On to /transcode/profile/{id} (http://mediamosa.org/node/3654)
it's a [get] request to obtain some information.
Under 'response fields', the columns 'Method' and 'Obligatory / Optional' seem rather strange (it's a response to a [get] request).
Please give the real Parameter names: 'name' --> 'profile_name'
'created', 'changed', 'profile_id' and 'global' are given in the response, but not in the table


Next: /transcode/profile/update/{id} [post] http://mediamosa.org/node/3657
Why is it /transcode/profile/update/{id} and not [post] /transcode/profile/{id} (same as mediafiles-acl's, asset metadata, ftp-users update, etc) or [post] /transcode/profile/{id}/update (same as profile/{id}/delete)
Acutally, later I found out, that the documentation is wrong: it's the preffered [post] /transcode/profile/{id} that is implemented...
Why do we need to give all parameters again (including name) if only one of them is changed?


/transcode/profile/create [post] http://mediamosa.org/node/3655
seems to work. Please document the max length of the file_extension parameter. That seems to be 4 characters.
In the 'example request URL', please show the minimum parameters needed.


Deletion of a trancode profile http://mediamosa.org/node/3656
the page mentions a [get] request, but obviously it is a [post]
The example response has a very strange last line: </items>. That should be <items/>.


Some general questions about transcoding rework.

The 'version' parameter. What can it be used for. It seems like the 'version' has to be set and get by the EGA, but has no functionality otherwise?

It seems like all profiles created by RESTcalls have 'global'=FALSE. Please document in a 'general' section about transcoding what this means.

Please note that while transcode id's from different EGA's cannot be seen in a /transcode/profile/{id} call, they can be used in a /mediafile/{id}/transcode call.

Changed 2 years ago by Michiel.Schok

  • status changed from closed to reopened
  • resolution fixed deleted

Reopen till documentation fixed.
I think an introductory chapter about transcoding and the changes in 1.7 is needed.
If needed / wanted, I can make a start. Just give a call.

Changed 2 years ago by forgacs

The attached .odt was just a proposal. Please, don't use it.
The mediamosa.org/api is updated, corrected.

"Acutally, later I found out, that the documentation is wrong: it's the preffered [post] /transcode/profile/{id} that is implemented..."

The documentation is fixed. The title of the page will be fixed later.

"Why do we need to give all parameters again (including name) if only one of them is changed?"

It is fixed. It is on the SVN.

"Please note that while transcode id's from different EGA's cannot be seen in a /transcode/profile/{id} call, they can be used in a /mediafile/{id}/transcode call."

It is fixed. It is on the SVN.

Changed 2 years ago by forgacs

  • owner set to MC-arjen
  • status changed from reopened to assigned

Changed 2 years ago by forgacs

"Why do we need to give all parameters again (including name) if only one of them is changed?"

We have introduced a new parameter: replace
If it is 'TRUE', the users have to give all the parameters. If 'FALSE', it is enough to POST the changed fields. Default is 'TRUE'.

The documentation was updated:
http://mediamosa.org/node/3657

Changed 2 years ago by MC-arjen

  • status changed from assigned to closed
  • resolution set to fixed

released in 1.7.1

Changed 2 years ago by Frans

  • version changed from 1.7.0 to 1.7.1

[Core] #19: /transcode/profile/{profile_id} [POST] added a
replace=TRUE/FALSE parameter.

Changed 2 years ago by Michiel.Schok

  • accepted changed from no to yes

replace=true/false works as advertised: OK
it's no longer possible to use a profile from another EGA: OK
Documentation changes: OK

Still open (for Frans to make an issue of it): General documentation on a high level about the Transcoding facilities of MediaMosa, and why it is implemented the way it is.

Tested and accepted.

Note: See TracTickets for help on using tickets.